com.appiancorp.suiteapi.applications

Class Application

java.lang.Object

com.appiancorp.suiteapi.common.Identity

com.appiancorp.suiteapi.content.Content

com.appiancorp.suiteapi.applications.Application

All Implemented Interfaces:

LocalId, ContentConstants, AppianTypeHolder, java.io.Serializable

public class Application
extends Content

Represents an Application object, which consists of metadata, a navigation definition, and references to associated objects. While the Application bean extends from Content, none of the methods inherited from Content into Application are supported other than the ones defined explicitly in this class. Example, if "Content" would expose a method called "doSomething", the use of "doSomething" in an Application bean is not supported and must not be used.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Application.ApplicationActions Definition of the Application Actions: a collection of ApplicationAction associated to the application.
static class	Application.ApplicationNavigation The end-user navigation definition of the application.
static class	Application.AssociatedApplications Stores the references to the applications associated with the application.
static class	Application.AssociatedObjects Stores the references to the objects associated with the application.
static class	Application.Metadata
static class	Application.Section An application is logically divided in four different sections: 1.

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, 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_RULE_CONSTANT, SUBTYPE_RULE_DECISION, SUBTYPE_RULE_DECISION_TABLE, SUBTYPE_RULE_FREEFORM, SUBTYPE_RULE_INTERFACE, SUBTYPE_RULE_OUTBOUND_INTEGRATION, SUBTYPE_RULE_QUERY, SUBYTYPE_MIGRATION_FLAG, SYSADMIN_GRP, SYSADMIN_UTYPE, SYSTEM_ASYNC_INSPECT_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_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

Constructors

Constructor and Description
Application()

Method Summary

Modifier and Type	Method and Description
void	addAction(java.lang.String displayLabel, java.lang.String processModelUuid, java.lang.String description) Adds a new application action to the end of the Application's actions list.
void	addAction(java.lang.String displayLabel, java.lang.String processModelUuid, java.lang.String description, int index) Adds a new application action to the Application's actions list at the specified position.
void	addNavigationItem(java.lang.String displayName, java.lang.String pageUuid, java.lang.String urlIdentifier) Adds a new navigation item to the Application's navigation definition to the end of the list.
void	addNavigationItem(java.lang.String displayName, java.lang.String pageUuid, java.lang.String urlIdentifier, int index) Adds a new navigation item to the Application's navigation definition at the specified index.
void	addObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type, java.lang.String[] uuids) Deprecated. use addObjectsByType(Long, Object[])
<H extends com.appiancorp.ix.Haul<I,U>,I,U> void	addObjectsByType(java.lang.Long appianTypeLong, U[] uuids) Associates objects of the specified type with the Application.
<H extends com.appiancorp.ix.Haul<I,U>,I,U> void	addObjectsByType(com.appiancorp.ix.Type<H,I,U> type, U[] uuids) Deprecated. use addObjectsByType(Long, Object[])
ApplicationAction[]	getActions() Returns the list of actions defined for the Application.
Application.ApplicationActions	getApplicationActions()
Application.ApplicationNavigation	getApplicationNavigation()
java.util.Set<java.lang.String>	getApplicationObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type) Deprecated. use getObjectsByType(Long)
Application.AssociatedApplications	getAssociatedApplications() Returns the associated applications.
Application.AssociatedObjects	getAssociatedObjects()
java.lang.String	getCompanyName() Gets the company name of the publisher of this application.
java.lang.String	getCompanyUrl() Gets the company web site URL of the application publisher as a String.
java.lang.String	getIconRelativePath() Gets this application's icon path if it is stored within the application server structure
java.lang.String	getLastModifiedBy() Gets the name of the user who last modified this Application
ApplicationNavigationItem[]	getNavigationItems() Returns the list of navigation items defined for the Application.
<H extends com.appiancorp.ix.Haul<I,U>,I,U> java.util.Set<U>	getObjectsByType(java.lang.Long appianTypeLong) Gets an unmodifiable set of all of the UUIDs of a specified Type that have been associated with this Application.
<H extends com.appiancorp.ix.Haul<I,U>,I,U> java.util.Set<U>	getObjectsByType(com.appiancorp.ix.Type<H,I,U> type) Deprecated. use getObjectsByType(Long)
java.lang.String	getPrefix() Gets the prefix of the application as a String.
boolean	getPublic() A public application gives "viewer" privileges to all users of the system.
java.lang.String	getUrlIdentifier() Returns the URL identifier for this Application.
boolean	isDefault() Tells if this application is marked as the default application.
boolean	isPublished() Gets the published state of the application.
boolean	isSystem() Whether or not this application is a system application.
ApplicationAction	removeAction(int index) Removes the ApplicationAction at the specified index.
ApplicationNavigationItem	removeNavigationItem(int index) Removes the navigation item at the specified index.
void	removeObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type, java.lang.String[] uuids) Deprecated. use removeObjectsByType(Long, Object[]) instead
<H extends com.appiancorp.ix.Haul<I,U>,I,U> void	removeObjectsByType(java.lang.Long appianTypeLong, U[] uuids) Dissociate specified objects from the Application.
<H extends com.appiancorp.ix.Haul<I,U>,I,U> void	removeObjectsByType(com.appiancorp.ix.Type<H,I,U> type, U[] uuids) Deprecated. use removeObjectsByType(Long, Object[]) instead
Application.ApplicationActions	setApplicationActions(Application.ApplicationActions applicationActions) Sets the {link ApplicationActions} containing the collection of actions.
Application.ApplicationNavigation	setApplicationNavigation(Application.ApplicationNavigation applicationNavigation)
Application.AssociatedApplications	setAssociatedApplications(Application.AssociatedApplications AssociatedApplications) Sets the associated applications See Application.AssociatedApplications
Application.AssociatedObjects	setAssociatedObjects(Application.AssociatedObjects associatedObjects)
void	setCompanyName(java.lang.String companyName) Sets the company name for this application.
void	setCompanyUrl(java.lang.String url) Sets a the given URL as the company URL for the application publisher.
void	setDefault(boolean isDefault) Marks this application as the default application.
void	setIconRelativePath(java.lang.String iconRelPath) Sets this application's icon path, if stored within the App server structure
void	setLastModifiedBy(java.lang.String lastModifiedBy) Sets the name of the user who last modified this Application
void	setPrefix(java.lang.String prefix) Sets the prefix of the application.
void	setPublic(boolean isPublic) A public application gives "viewer" privileges to all users of the system.
void	setPublished(boolean isPublished) Sets the published state of the application.
void	setSystem(boolean isSystem) Sets whether or not this application is a system application.
void	setUrlIdentifier(java.lang.String urlIdentifier) Sets the URL identifier for this Application.

Methods inherited from class com.appiancorp.suiteapi.content.Content

addSecurity, addSecurity, addVisibility, addVisibility, fillInAppianTypes, getActionRequested, getActionRequester, getAttributes, getChangesRequireApproval, getCreatedTimestamp, getCreator, getCurrentContentId, getDepth, getDescription, getDisplayName, getExpirationTimestamp, getFavorite, getForum, getLatestVersionId, getLockedAt, getLockedBy, getLockedByUsername, getLog, getLogName, getNumberOfVersions, getOriginalContentId, getParent, getParentName, getParentType, getPartition, getPartitionName, getPendingApprovalCount, getRoleSet, getSecurity, getSize, getState, getSubtype, getType, getTypesOfChildren, getUpdatedTimestamp, getUsersPendingAccess, getUuid, getVersionId, getVersions, getVisibility, hasChildrenOfType, removeSecurity, removeSecurity, removeVisibility, removeVisibility, securityContains, securityContains, setActionRequested, setActionRequester, setAttributes, setChangesRequireApproval, setCreatedTimestamp, setCreator, setCurrentContentId, setDepth, setDescription, setExpirationTimestamp, setFavorite, setForum, setLatestVersionId, setLockedAt, setLockedBy, setLockedByUsername, setLog, setLogName, setNumberOfVersions, setOriginalContentId, setParent, setParentName, setParentType, setPartition, setPartitionName, setPendingApprovalCount, setRoleSet, setSecurity, setSecurity, setSize, setState, setSubtype, setSubtype, setType, setTypesOfChildren, setUpdatedTimestamp, setUsersPendingAccess, setUuid, setVersionId, setVersions, setVisibility, setVisibility, toString, visibilityContains, visibilityContains

Methods inherited from class com.appiancorp.suiteapi.common.Identity

equals, getId, getName, hashCode, setId, setName

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Application

public Application()

Method Detail

getUrlIdentifier

@Transient
public java.lang.String getUrlIdentifier()

Returns the URL identifier for this Application. The identifier is used to directly navigate to the application via a dedicated URL.

See Also:

setUrlIdentifier(java.lang.String)

setUrlIdentifier

public void setUrlIdentifier(java.lang.String urlIdentifier)
                      throws InvalidApplicationException

Sets the URL identifier for this Application. This will be used to provide an intuitive URL for direct access to the application. Example, the URL identifier can be "expenses" to be accessed in: "www.appianbpm.com/app/expenses" A valid URL identifier can only contain a-Z, 0-9, dashes and underscores. Its maximum length is 256 characters.

Parameters:

urlIdentifier - The URL identifier for this Application.

Throws:

InvalidApplicationException - If the urlIdentifier is invalid.

getCompanyName

@Transient
public java.lang.String getCompanyName()

Gets the company name of the publisher of this application.

Returns:

The company name.

setCompanyName

public void setCompanyName(java.lang.String companyName)

Sets the company name for this application.

Parameters:

companyName - The new company name.

getCompanyUrl

@Transient
public java.lang.String getCompanyUrl()

Gets the company web site URL of the application publisher as a String.

Returns:

The company URL as a String.

setCompanyUrl

public void setCompanyUrl(java.lang.String url)

Sets a the given URL as the company URL for the application publisher.

Parameters:

url - The new company URL.

getLastModifiedBy

@Transient
public java.lang.String getLastModifiedBy()

Gets the name of the user who last modified this Application

Returns:

The username of whoever last modified this Application

setLastModifiedBy

public void setLastModifiedBy(java.lang.String lastModifiedBy)

Sets the name of the user who last modified this Application

Parameters:

lastModifiedBy - username that last modified this Application

setPublished

public void setPublished(boolean isPublished)

Sets the published state of the application. Published applications are available for viewing and selection from the End-User Environment.

Parameters:

isPublished - True to set the application to "published" in the end user environment.

isDefault

public boolean isDefault()

Tells if this application is marked as the default application.

Returns:

true if the application is the default application for the site

setDefault

public void setDefault(boolean isDefault)

Marks this application as the default application. This is an internal and non persisted application property. To set the default home application use ApplicationService.setDefaultApplication(Long).

Parameters:

isDefault - If this application is marked as the default one.

isPublished

@Transient
public boolean isPublished()

Gets the published state of the application. Published applications are available for viewing and selection from the End-User Environment.

setPublic

public void setPublic(boolean isPublic)

A public application gives "viewer" privileges to all users of the system. This has precedence over the ApplicationRoleMap, that is, if the user "john.smith" is in the "deny" list of the application role map, but this application is "public" using this flag. Then "john.smith" will have "viewer" privileges.

Parameters:

isPublic - If the application is to be public.

setSystem

public void setSystem(boolean isSystem)

Sets whether or not this application is a system application. Once the flag is set and the application saved, the flag can't be set back again to false.

Parameters:

isSystem - whether or not this application should be treated as a system app

isSystem

@Transient
public boolean isSystem()

Whether or not this application is a system application.

getPublic

public boolean getPublic()

A public application gives "viewer" privileges to all users of the system.

Returns:

If the application is public.

setIconRelativePath

public void setIconRelativePath(java.lang.String iconRelPath)

Sets this application's icon path, if stored within the App server structure

Parameters:

iconRelPath - the path where this application's icon is located

getIconRelativePath

@Transient
public java.lang.String getIconRelativePath()

Gets this application's icon path if it is stored within the application server structure

Returns:

the application icon path

getPrefix

@Transient
public java.lang.String getPrefix()

Gets the prefix of the application as a String. The application prefix is added by default to certain objects created within the application.

Returns:

The application prefix as a String.

setPrefix

public void setPrefix(java.lang.String prefix)
               throws InvalidApplicationException

Sets the prefix of the application. The application prefix is added by default to certain objects created within the application. It is suggested that the application prefix be unique for the Appian environment. An application prefix must meet the following requirements: < 5 characters in length No special characters Cannot all be numbers

Parameters:

prefix - The new application prefix.

Throws:

InvalidApplicationException

addNavigationItem

public void addNavigationItem(java.lang.String displayName,
                              java.lang.String pageUuid,
                              java.lang.String urlIdentifier)
                       throws InvalidNavigationItemException

Adds a new navigation item to the Application's navigation definition to the end of the list.

Parameters:

displayName - the label that will be shown to the user when rendering the navigation link

pageUuid - the UUID of the target page of the new navigation item

urlIdentifier - A short string that will be used to provide direct, intuitive URL access to the page, e.g. "www.appianbpm.com/app/expenses/create"

Throws:

InvalidNavigationItemException - If the parameters for the navigation item are invalid.

addNavigationItem

public void addNavigationItem(java.lang.String displayName,
                              java.lang.String pageUuid,
                              java.lang.String urlIdentifier,
                              int index)
                       throws InvalidNavigationItemException

Adds a new navigation item to the Application's navigation definition at the specified index.

Parameters:

displayName - the label that will be shown to the user when rendering the navigation link

pageUuid - the UUID of the target page of the new navigation item. It is expected that this page is part of the application.

urlIdentifier - A short string that will be used to provide direct, intuitive URL access to the page, e.g. "www.appianbpm.com/app/expenses/create"

index - The index where the item should be positioned (where 0 is the first element).

Throws:

InvalidNavigationItemException - If the parameters for the navigation item are invalid.

getNavigationItems

@Transient
public ApplicationNavigationItem[] getNavigationItems()

Returns the list of navigation items defined for the Application.

Returns:

the list of navigation items, represented as an array of ApplicationNavigationItems

removeNavigationItem

public ApplicationNavigationItem removeNavigationItem(int index)
                                               throws InvalidNavigationItemException

Removes the navigation item at the specified index.

Parameters:

index - the index of the navigation item.

Throws:

InvalidNavigationItemException - if the index is invalid.

addAction

public void addAction(java.lang.String displayLabel,
                      java.lang.String processModelUuid,
                      java.lang.String description)
               throws InvalidActionException

Adds a new application action to the end of the Application's actions list.

Parameters:

displayLabel - The user friendly label to use when displaying this action.

processModelUuid - The UUID of the process model that executes as part of this action. It is expected that this process model is part of the application.

description - The description of the action.

Throws:

InvalidActionException - If any of the parameters for the action is invalid.

addAction

public void addAction(java.lang.String displayLabel,
                      java.lang.String processModelUuid,
                      java.lang.String description,
                      int index)
               throws InvalidActionException

Adds a new application action to the Application's actions list at the specified position.

Parameters:

displayLabel - The user friendly label to use when displaying this action.

processModelUuid - The UUID of the process model that executes as part of this action. It is expected that this process model is part of the application.

description - The description of the action.

index - The index where the item should be positioned (where 0 is the first element).

Throws:

InvalidActionException - If any of the parameters for the action is invalid.

getActions

@Transient
public ApplicationAction[] getActions()

Returns the list of actions defined for the Application.

Returns:

the list of actions, represented as an array of ApplicationActions.

removeAction

public ApplicationAction removeAction(int index)
                               throws InvalidActionException

Removes the ApplicationAction at the specified index.

Parameters:

index - The index of the action to remove in the application's list of actions.

Throws:

InvalidActionException - If the index is invalid.

addObjects

@Deprecated
public void addObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type,
                                   java.lang.String[] uuids)
                            throws InvalidApplicationException

Deprecated. use addObjectsByType(Long, Object[])

Associates objects of the specified type with the Application.

Parameters:

type - Object type.

uuids - Array of UUIDs corresponding to the objects to be added. May be null but may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to add a null item.

addObjectsByType

@Deprecated
public <H extends com.appiancorp.ix.Haul<I,U>,I,U> void addObjectsByType(com.appiancorp.ix.Type<H,I,U> type,
                                                                                     U[] uuids)
                                                                              throws InvalidApplicationException

Deprecated. use addObjectsByType(Long, Object[])

Associates objects of the specified type with the Application.

Parameters:

type - Object type.

uuids - Array of UUIDs corresponding to the objects to be added. May be null but may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to add a null item.

addObjectsByType

public <H extends com.appiancorp.ix.Haul<I,U>,I,U> void addObjectsByType(java.lang.Long appianTypeLong,
                                                                         U[] uuids)
                                                                  throws InvalidApplicationException

Associates objects of the specified type with the Application.

Parameters:

appianTypeLong - Object type. The only supported content type is AppianTypeLong.CONTENT_ITEM. Any other content type passed in (e.g. AppianTypeLong.FOLDER) will be treated as AppianTypeLong.CONTENT_ITEM.

uuids - Array of UUIDs corresponding to the objects to be added. May be null but may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to add a null item.

getApplicationObjects

@Deprecated
public java.util.Set<java.lang.String> getApplicationObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type)

Deprecated. use getObjectsByType(Long)

Gets an unmodifiable set of all of the UUIDs of a specified Type that have been associated with this Application. Any attempts to modify the return set will return an UnsupportedOperationException. See Collections.unmodifiableSet(Set)

Parameters:

type - The object Type.

Returns:

An unmodifiable set with all the application UUIDs.

getObjectsByType

@Deprecated
public <H extends com.appiancorp.ix.Haul<I,U>,I,U> java.util.Set<U> getObjectsByType(com.appiancorp.ix.Type<H,I,U> type)

Deprecated. use getObjectsByType(Long)

Gets an unmodifiable set of all of the UUIDs of a specified Type that have been associated with this Application. Any attempts to modify the return set will return an UnsupportedOperationException. See Collections.unmodifiableSet(Set)

Parameters:

type - Object type.

Returns:

An unmodifiable set with all the application UUIDs.

getObjectsByType

public <H extends com.appiancorp.ix.Haul<I,U>,I,U> java.util.Set<U> getObjectsByType(java.lang.Long appianTypeLong)

Gets an unmodifiable set of all of the UUIDs of a specified Type that have been associated with this Application. Any attempts to modify the return set will return an UnsupportedOperationException. See Collections.unmodifiableSet(Set)

Parameters:

appianTypeLong - Object type. The only supported content type is AppianTypeLong.CONTENT_ITEM. Any other content type passed in (e.g. AppianTypeLong.FOLDER) will be treated as AppianTypeLong.CONTENT_ITEM.

Returns:

An unmodifiable set with all the application UUIDs.

removeObjects

@Deprecated
public void removeObjects(com.appiancorp.ix.Type<?,?,java.lang.String> type,
                                      java.lang.String[] uuids)
                               throws InvalidApplicationException,
                                      InvalidOperationException

Deprecated. use removeObjectsByType(Long, Object[]) instead

Dissociate specified objects from the Application.

Parameters:

type - Objects' type.

uuids - Array of UUIDs corresponding to the objects to be removed. May be null may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to remove a null item.

InvalidOperationException

removeObjectsByType

@Deprecated
public <H extends com.appiancorp.ix.Haul<I,U>,I,U> void removeObjectsByType(com.appiancorp.ix.Type<H,I,U> type,
                                                                                        U[] uuids)
                                                                                 throws InvalidApplicationException,
                                                                                        InvalidOperationException

Deprecated. use removeObjectsByType(Long, Object[]) instead

Dissociate specified objects from the Application.

Parameters:

type - Objects' type.

uuids - Array of UUIDs corresponding to the objects to be removed. May be null may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to remove a null item.

InvalidOperationException - If trying to remove an object associated an existing application item, such as an action or navigation item.

removeObjectsByType

public <H extends com.appiancorp.ix.Haul<I,U>,I,U> void removeObjectsByType(java.lang.Long appianTypeLong,
                                                                            U[] uuids)
                                                                     throws InvalidApplicationException,
                                                                            InvalidOperationException

Dissociate specified objects from the Application.

Parameters:

appianTypeLong - Object type. The only supported content type is AppianTypeLong.CONTENT_ITEM. Any other content type passed in (e.g. AppianTypeLong.FOLDER) will be treated as AppianTypeLong.CONTENT_ITEM.

uuids - Array of UUIDs corresponding to the objects to be removed. May be null may not be empty or contain null.

Throws:

InvalidApplicationException - If trying to remove a null item.

InvalidOperationException - If trying to remove an object associated with an existing application item, such as an action or navigation item.

getAssociatedApplications

@Transient
public Application.AssociatedApplications getAssociatedApplications()

Returns the associated applications. See Application.AssociatedApplications

setAssociatedApplications

public Application.AssociatedApplications setAssociatedApplications(Application.AssociatedApplications AssociatedApplications)

Sets the associated applications See Application.AssociatedApplications

Parameters:

AssociatedApplications - The associated applications to set

Returns:

The Application.AssociatedApplications

getAssociatedObjects

@Transient
public Application.AssociatedObjects getAssociatedObjects()

setAssociatedObjects

public Application.AssociatedObjects setAssociatedObjects(Application.AssociatedObjects associatedObjects)

getApplicationNavigation

@Transient
public Application.ApplicationNavigation getApplicationNavigation()

setApplicationNavigation

public Application.ApplicationNavigation setApplicationNavigation(Application.ApplicationNavigation applicationNavigation)

getApplicationActions

@Transient
public Application.ApplicationActions getApplicationActions()

setApplicationActions

public Application.ApplicationActions setApplicationActions(Application.ApplicationActions applicationActions)

Sets the {link ApplicationActions} containing the collection of actions.

Returns: