com.smartsheet.api.models.AbstractRow Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of smartsheet-sdk-java Show documentation
Show all versions of smartsheet-sdk-java Show documentation
Library for connecting to Smartsheet Services
package com.smartsheet.api.models;
/*
* #[license]
* Smartsheet SDK for Java
* %%
* Copyright (C) 2014 Smartsheet
* %%
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
* %[license]
*/
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.smartsheet.api.models.enums.AccessLevel;
import com.smartsheet.api.models.format.Format;
import java.util.Date;
import java.util.List;
public class AbstractRow extends IdentifiableModel{
@Override
@JsonIgnore(false)
public Long getId() {
return super.getId();
}
@Override
@JsonIgnore(false)
public IdentifiableModel setId(Long id) {
super.setId(id);
return this;
}
/** Represents the Sheet ID. */
private Long sheetId;
/** Represents the row number. */
private Integer rowNumber;
/** Represents the parent row number. */
private Integer parentRowNumber;
/** Represents the cells for this row. */
private List cells;
/** Represents the discussions for this row. */
private List discussions;
/** Represents the attachments for this row. */
private List attachments;
/** Represents the columns for this row. */
private List columns;
/** Represents the date and time the row was created. */
private Date createdAt;
/** Represents the date and time the row was modified. */
private Date modifiedAt;
/** A read-only flag to indicate if the row is expanded or collapsed. */
private Boolean expanded;
/** The version number that is incremented every time a sheet is modified. */
private Integer version;
/** The user's permissions on the sheet. */
private AccessLevel accessLevel;
/** Indicates if the row is locked. Defaults to false **/
private Boolean locked;
/** Indicates if the row is locked for the current user. Defaults to false. **/
private Boolean lockedForUser;
/** Represents the {@link Format} for this cell.*/
private Format format;
/** Represents the parent row ID. */
private Long parentId;
/** Represents the sibling row ID*/
private Long siblingId;
/** Represents the URL to the row of the sheet*/
private String permalink;
/** Indicates if the row is filtered out by a column filter*/
private Boolean filteredOut;
/** Indicates if the sheet is a project sheet with dependencies enabled and this row is in the critical path*/
private Boolean inCriticalPath;
/** Represents the conditional {@link Format} for this row.*/
private Format conditionalFormat;
/** Indicates if the row should be put at the top of the sheet*/
private Boolean toTop;
/** Indicates if the row should be put at the bottom of the sheet*/
private Boolean toBottom;
/** Indicates if the row should be put above the specified sibling row*/
private Boolean above;
/** User object containing name and email of the creator of this row */
private User createdBy;
/** User object containing name and email of the last person to modify this row */
private User modifiedBy;
/**
* Gets the user's permissions on the sheet.
*
* @return the access level
*/
public AccessLevel getAccessLevel() {
return accessLevel;
}
/**
* Sets the user's permissions on the sheet.
*
* @param accessLevel the new access level
*/
public AbstractRow setAccessLevel(AccessLevel accessLevel) {
this.accessLevel = accessLevel;
return this;
}
/**
* Gets the version number that is incremented every time a sheet is modified.
*
* @return the version
*/
public Integer getVersion() {
return version;
}
/**
* Sets the version number that is incremented every time a sheet is modified..
*
* @param version the new version
*/
public AbstractRow setVersion(Integer version) {
this.version = version;
return this;
}
/**
* Checks if the row is expanded.
*
* @return true, if is expanded
*/
public Boolean isExpanded() {
return expanded;
}
/**
* Sets the row to be expanded.
*
* @param expanded the new expanded
*/
public AbstractRow setExpanded(Boolean expanded) {
this.expanded = expanded;
return this;
}
/**
* Get a column by it's index.
*
* @param index the column index
* @return the column by index
*/
public TColumn getColumnByIndex(int index) {
if (columns == null) {
return null;
}
TColumn result = null;
for (TColumn column : columns) {
if (column.getIndex() == index) {
result = column;
break;
}
}
return result;
}
/**
* Get a column by it's ID.
*
* @param columnId the column id
* @return the column by id
*/
public TColumn getColumnById(long columnId) {
if (columns == null) {
return null;
}
TColumn result = null;
for (TColumn column : columns) {
if (column.getId() == columnId) {
result = column;
break;
}
}
return result;
}
/**
* Gets the id of the sheet.
*
* @return the sheet id
*/
public Long getSheetId() {
return sheetId;
}
/**
* Sets the sheet id.
*
* @param sheetId the new sheet id
*/
public AbstractRow setSheetId(Long sheetId) {
this.sheetId = sheetId;
return this;
}
/**
* Gets the row number.
*
* @return the row number
*/
public Integer getRowNumber() {
return rowNumber;
}
/**
* Sets the row number.
*
* @param rowNumber the new row number
*/
public AbstractRow setRowNumber(Integer rowNumber) {
this.rowNumber = rowNumber;
return this;
}
/**
* Gets the parent row number.
*
* @return the parent row number
*/
public Integer getParentRowNumber() {
return parentRowNumber;
}
/**
* Sets the parent row number.
*
* @param parentRowNumber the new parent row number
*/
public AbstractRow setParentRowNumber(Integer parentRowNumber) {
this.parentRowNumber = parentRowNumber;
return this;
}
/**
* Gets the cells.
*
* @return the cells
*/
public List getCells() {
return cells;
}
/**
* Sets the cells.
*
* @param cells the new cells
*/
public AbstractRow setCells(List cells) {
this.cells = cells;
return this;
}
/**
* Gets the discussions.
*
* @return the discussions
*/
public List getDiscussions() {
return discussions;
}
/**
* Sets the discussions.
*
* @param discussions the new discussions
*/
public AbstractRow setDiscussions(List discussions) {
this.discussions = discussions;
return this;
}
/**
* Gets the attachments.
*
* @return the attachments
*/
public List getAttachments() {
return attachments;
}
/**
* Sets the attachments.
*
* @param attachments the new attachments
*/
public AbstractRow setAttachments(List attachments) {
this.attachments = attachments;
return this;
}
/**
* Gets the columns.
*
* @return the columns
*/
public List getColumns() {
return columns;
}
/**
* Sets the columns.
*
* @param columns the new columns
*/
public AbstractRow setColumns(List columns) {
this.columns = columns;
return this;
}
/**
* Gets the date and time a row was created.
*
* @return the created at
*/
public Date getCreatedAt() {
return createdAt;
}
/**
* Sets the date and time a row was created.
*
* @param createdAt the new created at
*/
public AbstractRow setCreatedAt(Date createdAt) {
this.createdAt = createdAt;
return this;
}
/**
* Gets the date and time a row was modified.
*
* @return the modified at
*/
public Date getModifiedAt() {
return modifiedAt;
}
/**
* Sets the date and time a row was modified.
*
* @param modifiedAt the new modified at
*/
public AbstractRow setModifiedAt(Date modifiedAt) {
this.modifiedAt = modifiedAt;
return this;
}
/**
* Indicates whether a row is locked or not.
*
* @return the locked status
*/
public Boolean isLocked() {
return locked;
}
/**
* @param locked the locked status
*/
public AbstractRow setLocked(Boolean locked) {
this.locked = locked;
return this;
}
/**
* Indicates whether a row is locked for the user. Users cannot modify rows that are locked for them.
* @return the lock status for the user
*/
public Boolean isLockedForUser() {
return lockedForUser;
}
public AbstractRow setLockedForUser(Boolean lockedForUser) {
this.lockedForUser = lockedForUser;
return this;
}
/**
* @return the {@link Format}
*/
public Format getFormat() {
return format;
}
/**
* @param format the {@link Format} to set
*/
public AbstractRow setFormat(Format format) {
this.format = format;
return this;
}
/**
* Gets the row's parent ID.
*
* @return the ID of the parent
*/
public Long getParentId() {
return parentId;
}
/**
* Sets the parent row id.
*
* @param parentId the parent row id
*/
public AbstractRow setParentId(Long parentId) {
this.parentId = parentId;
return this;
}
/**
* Gets the row's sibling ID.
*
* @return the ID of the sibling
*/
public Long getSiblingId() {
return siblingId;
}
/**
* Sets the sibling row id.
*
* @param siblingId the sibling row id
*/
public AbstractRow setSiblingId(Long siblingId) {
this.siblingId = siblingId;
return this;
}
/**
* Gets the row's permalink URL.
*
* @return the permalink URL of the row
*/
public String getPermalink() {
return permalink;
}
/**
* Sets the parmalink URL.
*
* @param permalink the URL to the row
*/
public AbstractRow setPermalink(String permalink) {
this.permalink = permalink;
return this;
}
/**
* Check if the row is filtered out
*
* @return true, if it is filtered out
*/
public Boolean isFilteredOut() {
return filteredOut;
}
/**
* Sets the row to be filtered out.
*
* @param filteredOut if the row is filtered out
*/
public AbstractRow setFilteredOut(Boolean filteredOut) {
this.filteredOut = filteredOut;
return this;
}
/**
* Check if the row is in critical path
*
* @return true, if it is in critical path
*/
public Boolean isInCriticalPath() {
return inCriticalPath;
}
/**
* Sets the row to be in critical path.
*
* @param inCriticalPath if the row is in critical path
*/
public AbstractRow setInCriticalPath(Boolean inCriticalPath) {
this.inCriticalPath = inCriticalPath;
return this;
}
/**
* @return the conditional {@link Format}
*/
public Format getConditionalFormat() {
return conditionalFormat;
}
/**
* Sets the conditional format of the row.
*
* @param conditionalFormat the conditional format
*/
public AbstractRow setConditionalFormat(Format conditionalFormat) {
this.conditionalFormat = conditionalFormat;
return this;
}
/**
* Gets the to top.
*
* @return true, if row should be at the top
*/
public Boolean getToTop() {
return toTop;
}
/**
* Sets the to top
*
* @param toTop if the row is to the top
*/
public AbstractRow setToTop(Boolean toTop) {
this.toTop = toTop;
return this;
}
/**
* Gets the to bottom.
*
* @return true, if row should be at the bottom
*/
public Boolean getToBottom() {
return toBottom;
}
/**
* Sets the to bottom
*
* @param toBottom if the row is to the bottom
*/
public AbstractRow setToBottom(Boolean toBottom) {
this.toBottom = toBottom;
return this;
}
/**
* Gets the above.
*
* @return true, if row should be above the specified sibling ID
*/
public Boolean getAbove() {
return above;
}
/**
* Sets the above
*
* @param above if the row is above a specified row
*/
public AbstractRow setAbove(Boolean above) {
this.above = above;
return this;
}
/**
* Gets the User object containing name and email of the creator of this row.
*
* @return User object
*/
public User getCreatedBy() {
return createdBy;
}
/**
* Gets the User object containing name and email of the last person to modify this row.
*
* @return User object
*/
public User getModifiedBy() {
return modifiedBy;
}
}