com.appiancorp.suiteapi.applications

Interface ApplicationService

All Superinterfaces:

com.appiancorp.services.ContextSensitiveService, Service

public interface ApplicationService
extends com.appiancorp.services.ContextSensitiveService

Application service.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	create$UPDATES
static boolean	delete$UPDATES
static boolean	getApplication$UPDATES
static boolean	getApplicationsPaging$UPDATES
static boolean	getApplicationsWithRoleSetsPaging$UPDATES
static boolean	getApplicationWithRoleSet$UPDATES
static boolean	getDefaultApplication$UPDATES
static boolean	getRoleMap$UPDATES
static boolean	save$UPDATES
static boolean	setDefaultApplication$UPDATES
static boolean	setRoleMap$UPDATES
static boolean	updateAssociatedObjects$UPDATES

Fields inherited from interface com.appiancorp.services.ContextSensitiveService

SET_SERVICE_CONTEXT_METHOD_NAME

Method Summary

Modifier and Type	Method and Description
void	addAction(java.lang.Long appId, ApplicationAction action) Adds an Application Action with the given user friendly label, process model UUID, and description of the action.
java.lang.Long	create(Application application) Creates an application.
void	delete(java.lang.Long id) Deletes the specified application.
void	delete(java.lang.Long[] id) Deletes the specified applications.
Application	getApplication(java.lang.Long id) Retrieves an application given its id.
Application	getApplication(java.lang.String urlIdentifier) Retrieves an application given its URL identifier.
Application	getApplicationByUuid(java.lang.String uuid) Retrieves an application given its UUID.
ResultPage	getApplicationsPaging(int startIndex, int batchSize, java.lang.Integer sortProperty, java.lang.Integer sortOrder, boolean includeDrafts) Retrieves the applications defined on the system.
ResultPage	getApplicationsWithRoleSetsPaging(int startIndex, int batchSize, java.lang.Integer sortProperty, java.lang.Integer sortOrder, boolean includeDrafts) Retrieves the applications defined on the system with its ContentRoleSet set to a non-null value.
Application	getApplicationWithRoleSet(java.lang.Long id) Retrieves an application given its id with its ContentRoleSet set to a non-null value.
java.lang.Long	getDefaultApplication() Gets the default system application.
ApplicationRoleMap	getRoleMap(java.lang.Long id) Retrieves the security role map for the specified application.
void	save(Application application) Saves an application.
Application	save(Application application, java.util.Set<Application.Section> section) Saves only the specified section of the application.
void	setDefaultApplication(java.lang.Long id) Sets a default system application.
void	setRoleMap(java.lang.Long id, ApplicationRoleMap rolemap) Sets the security role map definition for the specified application.
void	updateAction(java.lang.Long appId, ApplicationAction updatedAction) Updates an existing Application Action with the given action that contains the new user friendly label, description of the action, and process model UUID.
Application	updateAssociatedObjects(java.lang.Long appId, com.appiancorp.ix.Type<?,?,java.lang.String> type, java.lang.String[] add, java.lang.String[] remove) Deprecated. use updateAssociatedObjectsByType(Long, Type, Object[], Object[]) instead
<H extends com.appiancorp.ix.Haul<I,U>,I,U> Application	updateAssociatedObjectsByType(java.lang.Long appId, com.appiancorp.ix.Type<H,I,U> type, U[] add, U[] remove) Associates or disassociates objects related to this application.

Methods inherited from interface com.appiancorp.services.ContextSensitiveService

setServiceContext

Field Detail

create$UPDATES

static final boolean create$UPDATES

See Also:

Constant Field Values

save$UPDATES

static final boolean save$UPDATES

See Also:

Constant Field Values

updateAssociatedObjects$UPDATES

static final boolean updateAssociatedObjects$UPDATES

See Also:

Constant Field Values

delete$UPDATES

static final boolean delete$UPDATES

See Also:

Constant Field Values

getApplication$UPDATES

static final boolean getApplication$UPDATES

See Also:

Constant Field Values

getApplicationWithRoleSet$UPDATES

static final boolean getApplicationWithRoleSet$UPDATES

See Also:

Constant Field Values

getApplicationsPaging$UPDATES

static final boolean getApplicationsPaging$UPDATES

See Also:

Constant Field Values

getApplicationsWithRoleSetsPaging$UPDATES

static final boolean getApplicationsWithRoleSetsPaging$UPDATES

See Also:

Constant Field Values

getRoleMap$UPDATES

static final boolean getRoleMap$UPDATES

See Also:

Constant Field Values

setRoleMap$UPDATES

static final boolean setRoleMap$UPDATES

See Also:

Constant Field Values

setDefaultApplication$UPDATES

static final boolean setDefaultApplication$UPDATES

See Also:

Constant Field Values

getDefaultApplication$UPDATES

static final boolean getDefaultApplication$UPDATES

See Also:

Constant Field Values

Method Detail

create

java.lang.Long create(Application application)
               throws InvalidApplicationException,
                      PrivilegeException

Creates an application.

Parameters:

application - The application object to be created.

Returns:

The id of the created application.

Throws:

InvalidApplicationException - if the application is in an inconsistent state or if its identifier matches that of any of the existing applications

PrivilegeException - if the user does not have permission to perform this action.

save

void save(Application application)
   throws InvalidApplicationException,
          PrivilegeException,
          ApplicationNotFoundException,
          UnavailableApplicationException,
          InvalidNavigationItemException,
          InvalidActionException

Saves an application.

Parameters:

application - The application to be updated.

Throws:

InvalidApplicationException - If an invalid Application is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If the ID field of the Application object does not match an object in the Database

UnavailableApplicationException - If the application couldn't be saved because it couldn't get the lock to it.

InvalidNavigationItemException - If the navigation item points to a page that is not already associated with the application.

InvalidActionException - If there is an action pointing to a process model that is not already associated with the application.

save

Application save(Application application,
                 java.util.Set<Application.Section> section)
          throws InvalidApplicationException,
                 PrivilegeException,
                 ApplicationNotFoundException,
                 UnavailableApplicationException,
                 InvalidNavigationItemException,
                 InvalidActionException

Saves only the specified section of the application. For example, if saving "metadata", this method won't modify the state of the bean related for associated objects nor navigation items.

Parameters:

application - The application to be updated.

section - The Application.Section(s) of the application to be updated.

Returns:

application The updated object bean. Notice that this object might be different from the one provided as parameter because this method only updates a given section of the bean. Example, if updating navigation objects, after saving the object, the application metadata might be different if other user updated that section.

Throws:

InvalidApplicationException - If an invalid Application is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If the ID field of the Application object does not match an object in the Database

UnavailableApplicationException - If the application couldn't be saved because it couldn't get the lock to it.

InvalidNavigationItemException - If there is a navigation item pointing to a page that is not already associated with the application.

InvalidActionException - If there is an action pointing to a process model that is not already associated with the application.

updateAssociatedObjects

@Deprecated
Application updateAssociatedObjects(java.lang.Long appId,
                                                com.appiancorp.ix.Type<?,?,java.lang.String> type,
                                                java.lang.String[] add,
                                                java.lang.String[] remove)
                                         throws InvalidApplicationException,
                                                PrivilegeException,
                                                ApplicationNotFoundException,
                                                InvalidOperationException,
                                                UnavailableApplicationException

Deprecated. use updateAssociatedObjectsByType(Long, Type, Object[], Object[]) instead

Associates or disassociates objects related to this application.

Parameters:

appId - The application id to update.

type - The type of the objects to associate/disassociate

add - The objects to associate with this application (can be null).

remove - The objects to dissasociate from this application (can be null).

Returns:

application The updated object bean. Notice that this object might be different from the one provided as parameter because this method only updates a given section of the bean. Example, if updating navigation objects, after saving the object, the application metadata might be different if other user updated that section.

Throws:

InvalidApplicationException - If an invalid Application id is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException

InvalidOperationException

UnavailableApplicationException - If the application couldn't be saved because it couldn't get the lock to it.

updateAssociatedObjectsByType

<H extends com.appiancorp.ix.Haul<I,U>,I,U> Application updateAssociatedObjectsByType(java.lang.Long appId,
                                                                                      com.appiancorp.ix.Type<H,I,U> type,
                                                                                      U[] add,
                                                                                      U[] remove)
                                                                               throws InvalidApplicationException,
                                                                                      PrivilegeException,
                                                                                      ApplicationNotFoundException,
                                                                                      InvalidOperationException,
                                                                                      UnavailableApplicationException

Associates or disassociates objects related to this application.

Parameters:

appId - The application id to update.

type - The type of the objects to associate/disassociate

add - The objects to associate with this application (can be null).

remove - The objects to dissasociate from this application (can be null).

Returns:

application The updated object bean. Notice that this object might be different from the one provided as parameter because this method only updates a given section of the bean. Example, if updating navigation objects, after saving the object, the application metadata might be different if other user updated that section.

Throws:

InvalidApplicationException - If an invalid Application id is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException

InvalidOperationException

UnavailableApplicationException - If the application couldn't be saved because it couldn't get the lock to it.

addAction

void addAction(java.lang.Long appId,
               ApplicationAction action)
        throws InvalidApplicationException,
               PrivilegeException,
               ApplicationNotFoundException,
               UnavailableApplicationException,
               InvalidActionException

Adds an Application Action with the given user friendly label, process model UUID, and description of the action.

Parameters:

appId - The application id to update.

action - The action to add.

Throws:

InvalidApplicationException - If an invalid Application id is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified ID.

UnavailableApplicationException - If the lock to the application cannot be obtained.

InvalidActionException - If the action points to a process model that is not already associated with the application.

updateAction

void updateAction(java.lang.Long appId,
                  ApplicationAction updatedAction)
           throws InvalidApplicationException,
                  PrivilegeException,
                  ApplicationNotFoundException,
                  UnavailableApplicationException,
                  InvalidActionException,
                  ActionNotFoundException

Updates an existing Application Action with the given action that contains the new user friendly label, description of the action, and process model UUID.

Parameters:

appId - The application id to update.

updatedAction - The action with an updated user friendly label, description, and process model UUID.

Throws:

InvalidApplicationException - If an invalid Application id is provided.

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified ID.

UnavailableApplicationException - If the lock to the application cannot be obtained.

InvalidActionException - If the action points to a process model that is not already associated with the application.

ActionNotFoundException - If the action to update does not exist.

delete

void delete(java.lang.Long id)
     throws PrivilegeException,
            ApplicationNotFoundException

Deletes the specified application.

Parameters:

id - The ID of the application to be deleted.

Throws:

PrivilegeException - if the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified IDs.

delete

void delete(java.lang.Long[] id)
     throws PrivilegeException,
            ApplicationNotFoundException

Deletes the specified applications.

Parameters:

id - An array IDs corresponding to the applications to be deleted.

Throws:

PrivilegeException - if the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with any of the specified IDs.

getApplication

Application getApplication(java.lang.Long id)
                    throws PrivilegeException,
                           ApplicationNotFoundException

Retrieves an application given its id.

Parameters:

id - The id of the application to be retrieved.

Returns:

The application bean whose id matches the given id.

Throws:

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified id.

getApplicationByUuid

Application getApplicationByUuid(java.lang.String uuid)
                          throws PrivilegeException,
                                 ApplicationNotFoundException

Retrieves an application given its UUID.

Parameters:

uuid - The UUID of the application to be retrieved.

Returns:

The application bean whose uuid matches the given uuid.

Throws:

PrivilegeException - If the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified uuid.

getApplication

Application getApplication(java.lang.String urlIdentifier)
                    throws ApplicationNotFoundException,
                           PrivilegeException

Retrieves an application given its URL identifier.

Parameters:

urlIdentifier - The URL identifier of the application to be retrieved.

Returns:

The application bean whose id matches the given URL identifier.

Throws:

ApplicationNotFoundException - If there is no application associated with the specified URL identifier.

PrivilegeException - If the user does not have permission to perform this action.

getApplicationWithRoleSet

Application getApplicationWithRoleSet(java.lang.Long id)
                               throws PrivilegeException,
                                      ApplicationNotFoundException

Retrieves an application given its id with its ContentRoleSet set to a non-null value. The ContentRoleSet represents the access permissions the current user has to this object. Use this method when you know in advance that you are going to use the user's access levels to the Application object. Usage example: app.getRoleSet().getCanAdministrate()

Parameters:

id - The id of the application to be retrieved.

Returns:

The application bean whose id matches the given id.

Throws:

PrivilegeException - if the user does not have permission to perform this action.

ApplicationNotFoundException - If there is no application associated with the specified id.

getApplicationsPaging

ResultPage getApplicationsPaging(int startIndex,
                                 int batchSize,
                                 java.lang.Integer sortProperty,
                                 java.lang.Integer sortOrder,
                                 boolean includeDrafts)

Retrieves the applications defined on the system.

Parameters:

startIndex - the index of the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize - the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty - The property by which the results will be sorted. This is one of the COLUMN_XXX constants in ContentConstants.

sortOrder - the order in which to sort the results.This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

includeDrafts - whether or not to include "DRAFT" applications with the results, otherwise, only "PUBLISHED" applications will be in the list. An application is in "published" mode when setting Application.setPublished(true)

Returns:

a ResultPage containing the list of Application objects.

See Also:

Application.setPublished.

getApplicationsWithRoleSetsPaging

ResultPage getApplicationsWithRoleSetsPaging(int startIndex,
                                             int batchSize,
                                             java.lang.Integer sortProperty,
                                             java.lang.Integer sortOrder,
                                             boolean includeDrafts)

Retrieves the applications defined on the system with its ContentRoleSet set to a non-null value. The ContentRoleSet represents the access permissions the current user has to this object. Use this method when you know in advance that you are going to* use the user's access levels to the Application object. Usage example: app.getRoleSet().getCanAdministrate()

Parameters:

startIndex - the index of the collection of total results at which to start. Negative numbers are treated as zeros.

batchSize - batchSize the number of results to return. Use Constants.COUNT_ALL to return the entire collection, but this is STRONGLY discouraged.

sortProperty - The property by which the results will be sorted. This is one of the COLUMN_XXX constants in ContentConstants.

sortOrder - sortOrder the order in which to sort the results.This is one of Constants.SORT_ORDER_ASCENDING or Constants.SORT_ORDER_DESCENDING

includeDrafts - whether or not to include "DRAFT" applications with the results, otherwise, only "PUBLISHED" applications will be in the list. An application is in "published" mode when setting Application.setPublished(true)

Returns:

a ResultPage containing the list of Application objects.

See Also:

Application.setPublished.

getRoleMap

ApplicationRoleMap getRoleMap(java.lang.Long id)
                       throws ApplicationNotFoundException,
                              PrivilegeException

Retrieves the security role map for the specified application.

Parameters:

id - The application id.

Returns:

ApplicationRoleMap

Throws:

PrivilegeException - if the user does not have permission to perform this action

ApplicationNotFoundException - If there is no application associated with the specified id.

setRoleMap

void setRoleMap(java.lang.Long id,
                ApplicationRoleMap rolemap)
         throws ApplicationNotFoundException,
                InvalidUserException,
                PrivilegeException

Sets the security role map definition for the specified application.

Parameters:

id - The application id.

rolemap - The application role map.

Throws:

InvalidUserException - if an invalid user or group is referenced

PrivilegeException - if the user does not have permission to perform this action

ApplicationNotFoundException - If there is no application associated with the specified id.

setDefaultApplication

void setDefaultApplication(java.lang.Long id)
                    throws PrivilegeException

Sets a default system application. This would be the first application that users see by default in the applications environment. Requires system administrator privileges and also assumes that the application exists.

Parameters:

id - The application id.

Throws:

PrivilegeException - If the user is not an admin.

getDefaultApplication

java.lang.Long getDefaultApplication()

Gets the default system application. If no default system application has been set, this will return null.

Returns:

The id of the default application.