Package com.appiancorp.suiteapi.content
Class Content
java.lang.Object
com.appiancorp.suiteapi.common.Identity
com.appiancorp.suiteapi.content.Content
- All Implemented Interfaces:
LocalId
,ContentConstants
,AppianTypeHolder
,Serializable
- Direct Known Subclasses:
Application
,Container
,CustomContent
,Document
,Rule
Represents an item of content. This can be manipulated in the database
using
ContentService
.
Content is a generic bean that can represent almost any structure that has
to be stored in the database. Currently, it is used to represent knowledge
and rule objects. The specific type of content is represented in the type
and subtype fields. Note that this class is abstract. You must instantiate
it by instantiating a sub-class.- See Also:
-
Field Summary
Fields inherited from interface com.appiancorp.suiteapi.content.ContentConstants
ACT_CREATE, ACT_DEACTIVATE, ACT_DELETE, AL_ADMIN, AL_EDITOR, AL_INVALID_ID, AL_NONE, AL_VIEWER, ALLOCATE_FSID, ALLOCATE_GLOBAL_PART, ALLOCATE_PART, APPLICATIONS_ROOT_DESCRIPTION, APPLICATIONS_ROOT_NAME, CHILDREN, COLUMN_ACTION_REQUESTED, COLUMN_ACTION_REQUESTER, COLUMN_ATTRIBUTES, COLUMN_CHANGES_REQUIRE_APPROVAL, COLUMN_CREATED_TIMESTAMP, COLUMN_CREATOR, COLUMN_DESCRIPTION, COLUMN_EXPIRATION_DAYS, COLUMN_EXPIRATION_TIMESTAMP, COLUMN_EXTENSION, COLUMN_FORUM, COLUMN_FSID, COLUMN_FSID_COUNT, COLUMN_ID, COLUMN_LOCKED_BY, COLUMN_LOG, COLUMN_LOG_NAME, COLUMN_METADATA_IDS, COLUMN_NAME, COLUMN_NONE, COLUMN_NUMBER_OF_VERSIONS, COLUMN_PARENT_ID, COLUMN_PARENT_NAME, COLUMN_PARENT_TYPE, COLUMN_PARTITION, COLUMN_PARTITION_NAME, COLUMN_SECURITY, COLUMN_SIZE, COLUMN_STATE, COLUMN_SUBTYPE, COLUMN_TYPE, COLUMN_UPDATED_TIMESTAMP, COLUMN_UUID, COLUMN_VERSION_ID, COLUMN_VERSIONS, COLUMN_VISIBILITY, COMMUNITY_ROOT, CONTENT_SECURITY_TYPE, CREATION_SECURITY_TYPE, FILTER_TYPE_ALL, GC_MOD_DRAFT, GC_MOD_LINKS, GC_MOD_NORMAL, GC_MOD_POPULATE_TYPES_OF_CHILDREN, GC_VERSIONS_AS_FOLDERS, I18N_PREFIX, IMPORT_INVALID_PRIVILEGE, IMPORT_NAME_EXISTS_WITHIN_PARENT, IMPORT_NAME_EXISTS_WITHIN_TYPE, IMPORT_NAME_WITH_UUID_EXISTS_WITHIN_PARENT, IMPORT_UUID_EXISTS_ELSEWHERE, IMPORT_VALID, INFINITY, KM_EXPIRATION_DURATION_CHECK, KM_SECURITY_COMMUNITY, KM_SECURITY_CONTENT_COMMUNITY, KM_SECURITY_CONTENT_FOLDER, KM_SECURITY_CONTENT_KC, KM_SECURITY_FOLDER, KM_SECURITY_KNOWLEDGE_CENTER, KNOWLEDGE_ROOT, KNOWLEDGE_ROOT_SYSTEM_ID, MIGRATION_FLAG, NEGATIVE_INFINITY, NO_CHILDREN, NO_EXPIRATION_TIMESTAMP, NO_FORUM, NO_REVIEW, QUERY_KEYWORDS, RESTRICTION_ROLE_MAP_ROLES, RM_AGGREGATE, RM_EXPLICIT, ROLE_ADMINISTRATORS, ROLE_AUTHORS, ROLE_DENY_ADMINISTRATORS, ROLE_DENY_AUTHORS, ROLE_DENY_READERS, ROLE_MAP_ROLES, ROLE_READERS, RULE_ENCODING, RULES_ROOT_DESCRIPTION, RULES_ROOT_NAME, RULES_ROOT_SYSTEM_ID, SEC_ALL_ADMIN, SEC_ALL_EDITOR, SEC_ALL_VIEWER, SEC_CREATOR_ADMIN, SEC_INH_ADMIN, SEC_INH_ADMIN_MASK, SEC_INH_ALL, SEC_INH_EDITOR, SEC_INH_VIEWER, SEC_PUBLIC, SECURITY_MANAGER_CONFIG, STATE_ACTIVE, STATE_ACTIVE_PENDING_APPROVAL, STATE_ACTIVE_PUBLISHED, STATE_ACTIVE_REJECTED, STATE_PENDING_APPROVAL, STATE_PUBLISHED, STATE_REJECTED, SUBTYPE_CONNECTED_SYSTEM, SUBTYPE_DATA_STORE_CONFIG, SUBTYPE_FOLDER_APPLICATIONS, SUBTYPE_FOLDER_CONNECTED_SYSTEMS, SUBTYPE_FOLDER_DATA_STORE_CONFIGS, SUBTYPE_FOLDER_KNOWLEDGE, SUBTYPE_FOLDER_MIGRATION_FLAGS, SUBTYPE_FOLDER_RULES, SUBTYPE_MIGRATION_FLAG, SUBTYPE_RULE_CONSTANT, SUBTYPE_RULE_DECISION, SUBTYPE_RULE_DECISION_TABLE, SUBTYPE_RULE_FREEFORM, SUBTYPE_RULE_INTERFACE, SUBTYPE_RULE_OUTBOUND_INTEGRATION, SUBTYPE_RULE_QUERY, SYSADMIN_GRP, SYSADMIN_UTYPE, SYSTEM_ASYNC_INSPECT_FOLDER_NAME, SYSTEM_COPILOT_FOLDER_NAME, SYSTEM_FOLDER_COVER_PHOTOS_NAME, SYSTEM_FOLDER_OFFLINE_RULE_BUNDLES_NAME, SYSTEM_FOLDER_RECORD_TYPES_NAME, SYSTEM_FOLDER_TEMPO_ATTACHMENTS_ROOT_DESCRIPTION, SYSTEM_FOLDER_TEMPO_ATTACHMENTS_ROOT_NAME, SYSTEM_IX_FOLDER_NAME, SYSTEM_OBJECT_TEMPLATES_FOLDER_NAME, SYSTEM_OPENAPI_FOLDER_NAME, SYSTEM_PACKAGES_FOLDER_NAME, SYSTEM_RECORD_TYPE_NAME_PREFIX, SYSTEM_SYSRULES_DESIGNER_ROOT_DESCRIPTION, SYSTEM_SYSRULES_DESIGNER_ROOT_NAME, SYSTEM_SYSRULES_INTERNAL_ROOT_DESCRIPTION, SYSTEM_SYSRULES_INTERNAL_ROOT_NAME, TYPE_ALL, TYPE_ANY_KC, TYPE_APPLICATION, TYPE_COMMUNITY, TYPE_COMMUNITY_KC, TYPE_CONTAINER, TYPE_CONTENT, TYPE_CUSTOM, TYPE_DOCUMENT, TYPE_FOLDER, TYPE_IGNORE, TYPE_NON_CONTAINER, TYPE_NON_DOCUMENT, TYPE_PERSONAL_KC, TYPE_RULE, UNIQUE_FOR_ALL, UNIQUE_FOR_PARENT, UNIQUE_FOR_SYSTEM_RULES_LATEST_VERSION, UNIQUE_FOR_TYPE, UNIQUE_FOR_TYPE_AND_SUBTYPE_LATEST_VERSION, UNIQUE_FOR_TYPE_LATEST_VERSION, UNIQUE_NONE, UUID_ACTIVE_PROCESSES_REPORT, UUID_ACTIVE_TASKS_GROUP_MEMBERS_REPORT, UUID_ACTIVE_TASKS_GROUP_REPORT, UUID_ACTIVE_TASKS_REPORT, UUID_ALL_PROCESS_MODELS_REPORT, UUID_ALL_PROCESSES_REPORT, UUID_ALL_TASKS_REPORT, UUID_APPLICATIONS_HOME, UUID_APPLICATIONS_ROOT, UUID_ASYNC_INSPECT_FOLDER, UUID_CANCELED_PROCESSES_REPORT, UUID_COMMUNITY_ROOT, UUID_COMPLETED_PROCESSES_REPORT, UUID_COMPLETED_TASKS_REPORT, UUID_COPILOT_FOLDER, UUID_CURRENT_TASKS_PER_PROCESS_REPORT, UUID_DATA_STORE_CONFIGS_ROOT_FOLDER, UUID_DEFAULT_COMMUNITY, UUID_EMAIL_FOOTER_TEMPLATE, UUID_EMAIL_HEADER_TEMPLATE, UUID_EMAIL_TEMPLATE_FOLDER, UUID_FAVORITE_PROCESS_MODELS_REPORT, UUID_FAVORITE_PROCESSES_REPORT, UUID_FAVORITE_TASKS_REPORT, UUID_HIGH_PRIORITY_TASKS_REPORT, UUID_IX_FOLDER, UUID_LEADER_MESSAGE_PICTURES_FOLDER, UUID_MIGRATION_FLAGS_ROOT_FOLDER, UUID_MOST_ACTIVE_PROCESS_MODELS_REPORT, UUID_NAVIGATION_CONFIG, UUID_NODE_STATS_PER_PROCESS_MODEL_REPORT, UUID_NODE_STATS_PER_PROCESS_REPORT, UUID_OBJECT_TEMPLATES_FOLDER, UUID_OFFLINE_RULE_BUNDLES_FOLDER, UUID_OPENAPI_FOLDER, UUID_OVERDUE_TASKS_REPORT, UUID_PACKAGES_FOLDER, UUID_PAUSED_PROCESSES_REPORT, UUID_PERFORMANCE_INDICATOR_GREEN, UUID_PERFORMANCE_INDICATOR_RED, UUID_PERFORMANCE_INDICATOR_YELLOW, UUID_PRIORITY_ICONS_FOLDER, UUID_PROCESS_DETAILS_PER_PROCESS_MODEL_REPORT, UUID_PROCESS_INSTANCES_PER_MODEL_REPORT, UUID_PROCESS_MODEL_REPORT_FOLDER, UUID_PROCESS_OPTIMIZATION_REPORTS_FOLDER, UUID_PROCESS_REPORTS_FOLDER, UUID_PROCESSES_STARTED_BY_ME_REPORT, UUID_PROCESSES_WITH_PROBLEMS_REPORT, UUID_RULES_ROOT_FOLDER, UUID_RUNNING_PROCESSES_PER_MODEL_REPORT, UUID_STATISTICS_ACROSS_PROCESSES_REPORT, UUID_SUBPROCESSES_PER_PROCESS_REPORT, UUID_SUMMARY_REPORTS_FOLDER, UUID_SYSTEM_DOC_PRIORITY_HIGH, UUID_SYSTEM_DOC_PRIORITY_LOW, UUID_SYSTEM_DOC_PRIORITY_NORMAL, UUID_SYSTEM_FOLDER_TEMPO_ATTACHMENTS, UUID_SYSTEM_KNOWLEDGE_CENTER, UUID_SYSTEM_RECORD_TYPES_FOLDER, UUID_SYSTEM_REPORTS_FOLDER, UUID_SYSTEM_SYSRULES_DESIGNER_ROOT, UUID_SYSTEM_SYSRULES_FOLDER_DESIGNER, UUID_SYSTEM_SYSRULES_FOLDER_ENGINEERING, UUID_SYSTEM_SYSRULES_FOLDER_EVOLVED_PREVIOUS_VERSIONS, UUID_SYSTEM_SYSRULES_FOLDER_HOME, UUID_SYSTEM_SYSRULES_INTERNAL_ROOT, UUID_TASK_REPORTS_FOLDER, UUID_TASKS_DUE_TODAY_REPORT, UUID_TASKS_FOR_USER_REPORT, UUID_TASKS_PER_PROCESS_MODEL_REPORT, UUID_TEMPORARY_DOCS_FOLDER, UUID_TEMPORARY_DOCS_KC, UUID_USER_COVER_PHOTOS_FOLDER, UUID_USER_PICTURES_FOLDER, UUID_USER_THUMBNAILS_FOLDER, UUID_VERSIONS_PER_PROCESS_MODEL_REPORT, VERSION_CURRENT, VERSION_ORIGINAL, VIS_ADVERTISE, VIS_DEFAULT, VIS_HIERARCHY, VIS_INDEXABLE, VIS_QUOTA, VIS_SEARCHABLE, VIS_SYSTEM, VIS_UNLOGGED
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addSecurity
(int security_) Adds security by bitwise orring it with the current security.void
addSecurity
(Integer security_) Adds security.void
addVisibility
(int visibility_) Adds visibility by bitwise orring it with the current visibility.void
addVisibility
(Integer visibility_) Adds visibility.void
fillInAppianTypes
(AppianTypeCache cache_) Adds the primary keys of any Appian-typed objects that are used by the mapping of this node to the given cache.Gets the action that was requested and is currently pending approval.Gets the username of the user that requested the action currently pending approval.Gets the attribute map, which can be used to store arbitary properties on content objects.Gets whether changes require approval.Gets the date and time the content was created.Gets the username of the user that created the content.Gets the content ID of the current (aka latest) version of this content.getDepth()
Gets the depth (if the content was returned by a service method that populates the depth).Gets the description.Gets the display name of the object.Gets the date and time that the content will expire.Gets whether this is favorite.getForum()
Deprecated.The Discussion Forums functionality will be removed in a future release.Snapshot of the Content's latest version ID.Gets the date and time that the content was locked, ornull
if the content is not locked.Deprecated.Gets the username of the user that has locked the content, or blank if the content is not locked.getLog()
Gets the log ID sent to the collaboration statistics server.Gets the name of the log kept by the collaboration statistics server.Gets the number of versions of the content that currently exist, excluding the current version.Gets the content ID of the original version of this content.Gets the ID of the parent (the container that contains this content).Gets the name of the parent (the container that contains this content).Gets the type of the parent (the container that contains this content).Gets the ID of the partition.Gets the name of the partition.Gets the role set.Gets the security, which indicates that the role map should be modified in some way.getSize()
Gets the size of the content object.getState()
Gets the current state of the content.Gets the subtype of the object.getType()
Gets the type of the content.Gets the typemask for the types of children that exist for this content (note: this only applies to containers).Gets the date and time that the content was last updated.String[]
Gets the list of usernames of users that are pending access (used for non-public content).getUuid()
Returns the UUID of the object.Gets the ID of the content version.Long[]
Deprecated.Gets the visibility, which indicates which parts of the application can see the content.boolean
hasChildrenOfType
(int typeMask_) Checks whether this content has children of a particular type or any of the types in the given type mask.void
removeSecurity
(int security_) Removes security by unsetting in the security any bits in the security parameter that were previously set.void
removeSecurity
(Integer security_) Removes security.void
removeVisibility
(int visibility_) Removes visibility by unsetting in the security any bits in the security parameter that were previously set.void
removeVisibility
(Integer visibility_) Removes visibility.boolean
securityContains
(int security_) Check whether the current security contains the security passed in.boolean
securityContains
(Integer security_) Check whether the current security contains the security passed in.void
setActionRequested
(Integer actionRequested_) Sets the action that was requested and is currently pending approval.void
setActionRequester
(String actionRequester_) Sets the username of the user that requested the action currently pending approval.void
setAttributes
(Map<String, Object> attributes_) Sets the attribute map, which can be used to store arbitary properties on content objects.void
setChangesRequireApproval
(Boolean changesRequireApproval_) Sets whether changes require approval.void
setCreatedTimestamp
(Timestamp createdTimestamp_) Sets the date and time the content was created.void
setCreator
(String creator_) Sets the username of the user that created the content.void
Sets the content ID of the current (aka latest) version of this content.void
Sets the depth.void
setDescription
(String description_) Sets the description.void
setExpirationTimestamp
(Timestamp expirationTimestamp_) Sets the date and time that the content will expire.void
setFavorite
(Boolean favorite_) Sets whether this is a favorite.void
Deprecated.The Discussion Forums functionality will be removed in a future release.void
setLatestVersionId
(Integer latestVersionId_) Sets the latest version ID of the Content.void
setLockedAt
(Timestamp lockedAt_) This field cannot be updated in the database.void
setLockedBy
(String lockedBy_) Deprecated.use {@link #setLockedByUsername(String))}void
setLockedByUsername
(String lockedByUsername) Sets the username of the user that has locked the content.void
Sets the log ID sent to the collaboration statistics server.void
setLogName
(String logName_) Sets the name of the log kept by the collaboration statistics server.void
setNumberOfVersions
(Long numberOfVersions_) Gets the number of versions of the content that currently exist, excluding the current version.void
Sets the content ID of the original version of this content.void
Sets the ID of the parent (the container that contains this content).void
setParentName
(String parentName_) Sets the name of the parent (the container that contains this content).void
setParentType
(Integer parentType_) Sets the type of the parent (the container that contains this content).void
setPartition
(Integer partition_) Sets the ID of the partition.void
setPartitionName
(String partitionName_) Sets the name of the partition.void
setPendingApprovalCount
(Integer pendingApprovalCount) This value will be ignored in create/update.void
setRoleSet
(ContentRoleSet roleSet_) Sets the role set.void
setSecurity
(int security_) Sets the security.void
setSecurity
(Integer security_) Sets the security, which indicates that the role map should be modified in some way.void
Sets the size of the content object.void
Sets the current state of the content.void
setSubtype
(int subtype_) Sets the subtype of the content.void
setSubtype
(Integer subtype_) Sets the subtype of the content.void
Gets the type of the content.void
setTypesOfChildren
(Integer typesOfChildren_) Sets the typemask for the types of children that exist for this content (note: this only applies to containers).void
setUpdatedTimestamp
(Timestamp updatedTimestamp_) Sets the date and time that the content was last updated.void
setUsersPendingAccess
(String[] usersPendingAccess_) Sets the list of usernames of users that are pending access (used for non-public content).void
Sets the UUID of the object.void
setVersionId
(Integer versionId_) Sets the ID of the content version.void
setVersions
(Long[] versions_) Deprecated.this field cannot be updated in the database.void
setVisibility
(int visibility_) Sets the visibility.void
setVisibility
(Integer visibility_) Sets the visibility, which indicates which parts of the application can see the content.toString()
Creates a string representation of the content (does not contain all fields).boolean
visibilityContains
(int visibility_) Check whether the current visibility contains the visibility passed in.boolean
visibilityContains
(Integer visibility_) Check whether the current visibility contains the visibility passed in.
-
Constructor Details
-
Content
public Content()Default constructor (necessary for return converters). Sets visibility toContentConstants.VIS_DEFAULT
. Sets security to none. -
Content
protected Content(int type_) Constructs a newContent
bean with the given type. Sets visibility toContentConstants.VIS_DEFAULT
. Sets security to none.- Parameters:
type_
- the content type- See Also:
-
Content
Constructs a newContent
bean with the given type.- Parameters:
type_
- the content type
-
-
Method Details
-
getUuid
@ConvertWith(com.appiancorp.kougar.mapper.parameters.UuidParameterConverter.class) public String getUuid()Description copied from class:Identity
Returns the UUID of the object. -
setUuid
Description copied from class:Identity
Sets the UUID of the object. -
getPendingApprovalCount
- Returns:
- count of content items with pending approvals, including this content item and its children
-
setPendingApprovalCount
This value will be ignored in create/update. -
getAttributes
Gets the attribute map, which can be used to store arbitary properties on content objects. The attribute map is also used to store certain fields for rules and constants, however do not call this method to directly retrieve attributes for rules or constants. Instead, call the getters onConstant
orFreeformRule
so that the class-specific handling is applied to the retrieved value.- Returns:
- the attribute map
- See Also:
-
setAttributes
Sets the attribute map, which can be used to store arbitary properties on content objects. The attribute map is also used to store certain fields for rules and constants, however do not call this method to directly modify attributes for rules or constants. Instead, call the setters onConstant
orFreeformRule
so that the class-specific handling is applied to the stored value. This field can be updated in the database.- Parameters:
attributes_
- the attribute map- See Also:
-
getSize
Gets the size of the content object. The meaning of "size" can vary depending on the type. Specifically for aDocument
, the size is the size of the file stored in bytes. This size counts against the user's quota.- Returns:
- the size
- See Also:
-
setSize
Sets the size of the content object. The meaning of "size" can vary depending on the type. Specifically for aDocument
, the size is the size of the file stored in bytes. This size counts against the user's quota. This field can be updated in the database.- Parameters:
size_
- the size of the content- See Also:
-
getChangesRequireApproval
Gets whether changes require approval.- Returns:
Boolean.TRUE
if changes require approval,Boolean.FALSE
otherwise- See Also:
-
setChangesRequireApproval
Sets whether changes require approval.- Parameters:
changesRequireApproval
-Boolean.TRUE
if changes require approval,Boolean.FALSE
otherwise- See Also:
-
getCreatedTimestamp
Gets the date and time the content was created. This field can be updated in the database.- Returns:
- the date and time the content was created
- See Also:
-
setCreatedTimestamp
Sets the date and time the content was created.- Parameters:
createdTimestamp_
- the date and time the content was created- See Also:
-
getCreator
Gets the username of the user that created the content. For non-container content, the creator is the user who created the last version of the content.- Returns:
- the username
- See Also:
-
setCreator
Sets the username of the user that created the content. This field can be updated in the database.- Parameters:
creator_
- the username- See Also:
-
getDepth
Gets the depth (if the content was returned by a service method that populates the depth).- Returns:
- the depth
- See Also:
-
setDepth
Sets the depth. This field cannot be updated in the database.- Parameters:
depth_
- the depth- See Also:
-
getDescription
Gets the description. If the description starts with "##!", then it is internationalized and the internationalization value should be looked up in Java.- Returns:
- the description
- See Also:
-
setDescription
Sets the description. This field can be updated in the database.- Parameters:
description_
- the description- See Also:
-
getExpirationTimestamp
Gets the date and time that the content will expire. If this isnull
, the content will never expire.- Returns:
- the date and time that the content will expire
- See Also:
-
setExpirationTimestamp
Sets the date and time that the content will expire. If this isnull
, the content will never expire. This field can be updated in the database.- Parameters:
expirationTimestamp_
- the date and time that the content will expire- See Also:
-
getForum
Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Gets the ID of the forum used to discuss this content, ornull
if no such forum has yet been created. UseDiscussionMetadataCoreService
andDiscussionMetadataConvenienceService
to manipulate the forums. When this is set to a forum ID,Forum.getRelateds()
should include this content.- Returns:
- the ID of the forum
- See Also:
-
setForum
Deprecated.The Discussion Forums functionality will be removed in a future release. Use the News feed and related smart services to build applications with similar functionality.Sets the ID of the forum used to discuss this content. UseDiscussionMetadataCoreService
andDiscussionMetadataConvenienceService
to manipulate the forums. When this is set to a forum ID,Forum.getRelateds()
should include this content. This field can be updated in the database. You must have admin privileges to change this field if it has already been set to a forum (a non-zero value).- Parameters:
forum_
- the ID of the forum- See Also:
-
getLockedBy
Deprecated.Gets the username of the user that has locked the content, ornull
if the content is not locked.- Returns:
- the username
- See Also:
-
setLockedBy
Deprecated.use {@link #setLockedByUsername(String))}Sets the username of the user that has locked the content, ornull
if the content is not locked. This field cannot be updated in the database. Set byContentService.lock(Long[])
,ContentService.unlock(Long[])
, andContentService.breakLock(Long[])
. If the content is not locked, this is set to ANONYMOUS or blank.- Parameters:
lockedBy_
- the username- See Also:
-
getLockedAt
Gets the date and time that the content was locked, ornull
if the content is not locked.- Returns:
- the date and time that the content was locked
- See Also:
-
setLockedAt
This field cannot be updated in the database.- Parameters:
lockedAt_
- the date and time that the content was locked.- See Also:
-
getLog
Gets the log ID sent to the collaboration statistics server. It is guaranteed to be unique for versions of content objects, and a value is never reused.- Returns:
- the log ID
- See Also:
-
setLog
Sets the log ID sent to the collaboration statistics server. This field can be updated in the database.- Parameters:
log_
- the log ID- See Also:
-
getLogName
Gets the name of the log kept by the collaboration statistics server.- Returns:
- the name of the log
- See Also:
-
setLogName
Sets the name of the log kept by the collaboration statistics server. This field cannot be updated in the database.- Parameters:
logName_
- the name of the log- See Also:
-
getParent
Gets the ID of the parent (the container that contains this content).- Returns:
- the ID of the parent
- See Also:
-
setParent
Sets the ID of the parent (the container that contains this content). The parent cannot be set to the piece of content itself. This field can be updated in the database.- Parameters:
parent_
- the ID of the parent- See Also:
-
getParentName
Gets the name of the parent (the container that contains this content).- Returns:
- the name of the parent
- See Also:
-
setParentName
Sets the name of the parent (the container that contains this content). This field cannot be updated in the database.- Parameters:
parentName_
- the name of the parent- See Also:
-
getParentType
Gets the type of the parent (the container that contains this content).- Returns:
- the type of the parent
- See Also:
-
setParentType
Sets the type of the parent (the container that contains this content). This field cannot be updated in the database.- Parameters:
parentType_
- the type of the parent- See Also:
-
getActionRequested
Gets the action that was requested and is currently pending approval. One ofContentConstants.ACT_DELETE
,ContentConstants.ACT_DEACTIVATE
, orContentConstants.ACT_CREATE
. This isnull
if no action is pending approval. This is only populated fromContentService.getRequests()
.- Returns:
- the action that was requested
- See Also:
-
setActionRequested
Sets the action that was requested and is currently pending approval. This field cannot be updated in the database.- Parameters:
actionRequested_
- the action that was requested- See Also:
-
getActionRequester
Gets the username of the user that requested the action currently pending approval. This isnull
if no action is pending approval. This is only populated fromContentService.getRequests()
.- Returns:
- the username
- See Also:
-
setActionRequester
Sets the username of the user that requested the action currently pending approval. This field cannot be updated in the database.- Parameters:
actionRequester_
- the username- See Also:
-
getSecurity
Gets the security, which indicates that the role map should be modified in some way. Different security modifiers can be combined by using the bitwise or operator. For instance, a security ofContentConstants.SEC_INH_VIEWER | ContentConstants.SEC_PUBLIC
would indicate that the content should both inherit viewers and be considered public.- Returns:
- the security modifiers
- See Also:
-
setSecurity
Sets the security, which indicates that the role map should be modified in some way. Different security modifiers can be combined by using the bitwise or operator. For instance, a security ofContentConstants.SEC_INH_VIEWER | ContentConstants.SEC_PUBLIC
would indicate that the content should both inherit viewers and be considered public. This field can be updated in the database. if visibility does not haveContentConstants.VIS_SYSTEM
set- Parameters:
security_
- the security modifiers- See Also:
-
setSecurity
public void setSecurity(int security_) Sets the security. This method callssetSecurity(Integer)
.- Parameters:
security_
- the security- See Also:
-
addSecurity
Adds security. This method callsaddSecurity(int)
.- Parameters:
security_
- the security to add- See Also:
-
addSecurity
public void addSecurity(int security_) Adds security by bitwise orring it with the current security.- Parameters:
security_
- the security to add- See Also:
-
removeSecurity
Removes security. This method callsremoveSecurity(int)
.- Parameters:
security_
- the security to remove- See Also:
-
removeSecurity
public void removeSecurity(int security_) Removes security by unsetting in the security any bits in the security parameter that were previously set.- Parameters:
security_
- the security to remove- See Also:
-
securityContains
Check whether the current security contains the security passed in. This method callssecurityContains(int)
.- Parameters:
security_
- the security to check for- Returns:
- true if the current security contains the parameter, false otherwise
-
securityContains
public boolean securityContains(int security_) Check whether the current security contains the security passed in. This returns true if there is ANY bit overlap, i.e., if any of the security modifiers in the current security match up with any of the modifiers in the security passed in. For instance, if the current security isContentConstants.SEC_INH_ADMIN
andContentConstants.SEC_PUBLIC
, and the security to check for isContentConstants.SEC_PUBLIC
andContentConstants.SEC_CREATOR_ADMIN
, this method returns true.- Parameters:
security_
- the security to check for- Returns:
- true if the current security contains the parameter, false otherwise
-
getState
Gets the current state of the content. One of theContentConstants
.STATE_XXX constants.- Returns:
- the state
- See Also:
-
setState
Sets the current state of the content. This field can only be updated in the database when specified explicitly in the list of fields to update when using the APIContentService.updateFields(com.appiancorp.suiteapi.content.Content, java.lang.Integer[], java.lang.Integer)
API. All other create/update APIs ignore the set value.- Parameters:
state_
- the state- See Also:
-
getSubtype
Gets the subtype of the object. Currently, the subtype is only applicable toFolder
andRule
objects.- Returns:
- the subtype
- See Also:
-
setSubtype
Sets the subtype of the content. Currently, the subtype is only applicable toFolder
andRule
objects. This field can be updated in the database.- Parameters:
subtype_
- the subtype- See Also:
-
setSubtype
public void setSubtype(int subtype_) Sets the subtype of the content. This method simply callssetSubtype(Integer)
.- Parameters:
subtype_
- the subtype- See Also:
-
getType
Gets the type of the content. One ofContentConstants.TYPE_DOCUMENT
,ContentConstants.TYPE_FOLDER
,ContentConstants.TYPE_PERSONAL_KC
,ContentConstants.TYPE_COMMUNITY_KC
,ContentConstants.TYPE_COMMUNITY
,ContentConstants.TYPE_RULE
,ContentConstants.TYPE_APPLICATION
, orContentConstants.TYPE_CUSTOM
.- Returns:
- the type
- See Also:
-
setType
Gets the type of the content. One ofContentConstants.TYPE_DOCUMENT
,ContentConstants.TYPE_FOLDER
,ContentConstants.TYPE_PERSONAL_KC
,ContentConstants.TYPE_COMMUNITY_KC
,ContentConstants.TYPE_COMMUNITY
,ContentConstants.TYPE_RULE
,ContentConstants.TYPE_APPLICATION
, orContentConstants.TYPE_CUSTOM
. When you create one of the sub-classes ofContent
, the type is automatically set. This field can be updated in the database.- Parameters:
type_
- the type- See Also:
-
getUpdatedTimestamp
Gets the date and time that the content was last updated.- Returns:
- the date and time that the content was last updated
- See Also:
-
setUpdatedTimestamp
Sets the date and time that the content was last updated. This field can be updated in the database. It will be automatically updated to current time in an update if not set or not modified manually.- Parameters:
updatedTimestamp_
- the date and time that the content was last updated.- See Also:
-
getUsersPendingAccess
Gets the list of usernames of users that are pending access (used for non-public content). This is only populated fromContentService.getRequests()
.- Returns:
- the array of usernames
- See Also:
-
setUsersPendingAccess
Sets the list of usernames of users that are pending access (used for non-public content). This field cannot be updated in the database.- Parameters:
usersPendingAccess_
- the array of usernames- See Also:
-
getVersionId
Gets the ID of the content version. The current version of content has an ID of -1. Previous versions of content have IDs starting with 1 for the oldest and incrementing by 1. Non-versioned content will have anull
version ID.- Returns:
- the ID of the content version
- See Also:
-
setVersionId
Sets the ID of the content version. This field cannot be updated in the database.- Parameters:
versionId_
- the ID of the content version- See Also:
-
getLatestVersionId
Snapshot of the Content's latest version ID.- Returns:
- the latest version ID of the Content
- See Also:
-
setLatestVersionId
Sets the latest version ID of the Content. This field cannot be updated in the database.- Parameters:
lastestVersionId_
- the latest version ID of the Content- See Also:
-
getVersions
Deprecated.Returns null. Before deprecation, got the content IDs of all of the versions of this content. The fullContent
beans for the versions can be obtained by callingContentService.getContentList(Long[], Integer)
. However, if there exists only 1 version of the document then the only entry that exists in the returned versions list is -1L.- Returns:
- the version IDs
- See Also:
-
setVersions
Deprecated.this field cannot be updated in the database.This field cannot be updated in the database. Set byContentService.createVersion(Content[], Integer)
.- Parameters:
versions_
- the version IDs- See Also:
-
getOriginalContentId
Gets the content ID of the original version of this content.- If there is no version or only 1 version of the content, the
ID of the content
is returned. - If more than 1 version of the content exists, the ID corresponding to the last element
(i.e. the first/original version) from the
list of versions
is returned.
- Returns:
- The content ID corresponding to the original version.
- See Also:
- If there is no version or only 1 version of the content, the
-
setOriginalContentId
Sets the content ID of the original version of this content. This method is called by the system when retrieving a Content object.- Parameters:
id
-- See Also:
-
getCurrentContentId
Gets the content ID of the current (aka latest) version of this content.- If there is no version or only 1 version of the content, the
ID of the content
is returned. - If more than 1 version of the content exists, the ID corresponding to the first element
(i.e. the current/latest version) from the
list of versions
is returned.
- Returns:
- The content ID corresponding to the current version.
- See Also:
- If there is no version or only 1 version of the content, the
-
setCurrentContentId
Sets the content ID of the current (aka latest) version of this content. This method is called by the system when retrieving a Content object.- Parameters:
id
-- See Also:
-
getVisibility
Gets the visibility, which indicates which parts of the application can see the content. Different visibility modifiers can be combined by using the bitwise or operator. For instance, a visibility ofContentConstants.VIS_HIERARCHY | ContentConstants.VIS_SEARCHABLE
would indicate that the content would appear in the hierarchy and would be searchable.- Returns:
- the visibility modifiers
- See Also:
-
setVisibility
Sets the visibility, which indicates which parts of the application can see the content. Different visibility indicators can be combined by using the bitwise or operator. For instance, a visibility ofContentConstants.VIS_HIERARCHY | ContentConstants.VIS_SEARCHABLE
would indicate that the content would appear in the hierarchy and would be searchable. This field can be updated in the database.- Parameters:
visibility_
- the visibility modifiers- See Also:
-
setVisibility
public void setVisibility(int visibility_) Sets the visibility. This method callssetVisibility(Integer)
.- Parameters:
visibility_
- the visibility- See Also:
-
addVisibility
Adds visibility. This method callsaddVisibility(int)
.- Parameters:
visibility_
- the visibility to add
-
addVisibility
public void addVisibility(int visibility_) Adds visibility by bitwise orring it with the current visibility.- Parameters:
visibility_
- the visibility to add
-
removeVisibility
Removes visibility. This method callsremoveVisibility(int)
.- Parameters:
visibility_
- the visibility to remove
-
removeVisibility
public void removeVisibility(int visibility_) Removes visibility by unsetting in the security any bits in the security parameter that were previously set.- Parameters:
visibility_
- the visibility to remove- See Also:
-
visibilityContains
Check whether the current visibility contains the visibility passed in. This method callsvisibilityContains(int)
.- Parameters:
visibility_
- the visibility to check for- Returns:
- true if the current visibility contains the parameter, false otherwise
-
visibilityContains
public boolean visibilityContains(int visibility_) Check whether the current visibility contains the visibility passed in. This returns true if there is ANY bit overlap, i.e., if any of the visibility modifiers in the current visibility match up with any of the modifiers in the visibility passed in. For instance, if the current visibility isContentConstants.VIS_HIERARCHY
andContentConstants.VIS_SEARCHABLE
, and the visibility to check for isContentConstants.VIS_SEARCHABLE
andContentConstants.VIS_QUOTA
, this method returns true.- Parameters:
visibility_
- the visibility to check for- Returns:
- true if the current visibility contains the parameter, false otherwise
-
getPartition
Gets the ID of the partition. A partition allows distribution of resources so they need not all occupy the same system resources. In particular, this is available so files on the filesystem may be distributed among multiple OS partitions or directories. This value cannot be negative. This API is not supported for Appian Cloud environments- Returns:
- the partition ID
- See Also:
-
setPartition
Sets the ID of the partition. A partition allows distribution of resources so they need not all occupy the same system resources. In particular, this is available so files on the filesystem may be distributed among multiple OS partitions or directories. This value cannot be negative. This field can be updated in the database. This API is not supported for Appian Cloud environments- Parameters:
partition_
- the partition ID- See Also:
-
getPartitionName
Gets the name of the partition. A partition allows distribution of resources so they need not all occupy the same system resources. In particular, this is available so files on the filesystem may be distributed among multiple OS partitions or directories. This API is not supported for Appian Cloud environments- Returns:
- the name of the partition
- See Also:
-
setPartitionName
Sets the name of the partition. A partition allows distribution of resources so they need not all occupy the same system resources. In particular, this is available so files on the filesystem may be distributed among multiple OS partitions or directories. This field cannot be updated in the database. This API is not supported for Appian Cloud environments- Parameters:
partitionName_
- the name of the partition- See Also:
-
getRoleSet
Gets the role set. This is not automatically populated when you get content from theContentService
. However, you can have the content service populate this field by callingContentService.populateRoleSets(Content[])
.- Returns:
- the role set
- See Also:
-
setRoleSet
Sets the role set.- Parameters:
roleSet_
- the role set- See Also:
-
getTypesOfChildren
Gets the typemask for the types of children that exist for this content (note: this only applies to containers). This is not automatically populated when you get content from theContentService
. However, you can have the content service populate this field by callingContentService.populateTypesOfChildren(Content[])
.- Returns:
- a typemask for the types of children
- See Also:
-
setTypesOfChildren
Sets the typemask for the types of children that exist for this content (note: this only applies to containers).- Parameters:
typesOfChildren_
- the typemask for the types of children- See Also:
-
getFavorite
Gets whether this is favorite. This is not automatically populated when you get content from theContentService
. However, you can have the content service populate this field by callingContentService.populateFavorites(Content[])
.- Returns:
- whether this is a favorite
- See Also:
-
setFavorite
Sets whether this is a favorite.- Parameters:
favorite_
- whether this is a favorite- See Also:
-
hasChildrenOfType
public boolean hasChildrenOfType(int typeMask_) Checks whether this content has children of a particular type or any of the types in the given type mask. You must populate the types of children first by callingContentService.populateTypesOfChildren(Content[])
.- Parameters:
typeMask_
- the type mask to check- Returns:
- whether the content has the children
-
toString
Creates a string representation of the content (does not contain all fields). -
getDisplayName
Gets the display name of the object. This value is used in the interfaces that display the content. This should be overridden if you want the display name to be different from the name. It has already been overridden forDocument
.- Returns:
- the display name
-
getNumberOfVersions
Gets the number of versions of the content that currently exist, excluding the current version. For instance, if there are two previous versions in addition to the current version, this will return 2.- Returns:
- the number of versions
- See Also:
-
setNumberOfVersions
Gets the number of versions of the content that currently exist, excluding the current version. For instance, if there are two previous versions in addition to the current version, this will return 2. This field cannot be updated in the database. Set byContentService.createVersion(Content[], Integer)
.- Parameters:
numberOfVersions_
- the number of versions- See Also:
-
fillInAppianTypes
Adds the primary keys of any Appian-typed objects that are used by the mapping of this node to the given cache.- Specified by:
fillInAppianTypes
in interfaceAppianTypeHolder
- Parameters:
cache_
- the cache that will hold the values
-
getLockedByUsername
Gets the username of the user that has locked the content, or blank if the content is not locked.- Returns:
- the username
-
setLockedByUsername
Sets the username of the user that has locked the content. This field cannot be updated in the database. Set byContentService.lock(Long[])
,ContentService.unlock(Long[])
, andContentService.breakLock(Long[])
. If the content is not locked, this is set to blank.- Parameters:
lockedByUsername
- the username
-