Interface ProcessAdministrationService
- All Superinterfaces:
com.appiancorp.services.ContextSensitiveService
,Service
ProcessAdministrationService is used to create and modify properties of the overall process application.
A Palette
holds a collection of
nodes that can be dropped onto a canvas in the
designer to create a process. Each node is represented as a
PaletteItem
. A
PaletteCategory
is an entity that
holds palettes and/or other palette categories in a
hierarchy.
When a system administrator adds a new activity to the system (also known as registering), an instance of this class is used to represent that activity. When a process designer puts a node in a process model, he or she is using an ActivityClass, which has a reference to this schema. The schema specifies what the parameters of an activity are and some of the restrictions on those parameters that constrain the designer's behavior.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
static final boolean
Fields inherited from interface com.appiancorp.services.ContextSensitiveService
SET_SERVICE_CONTEXT_METHOD_NAME
-
Method Summary
Modifier and TypeMethodDescriptionGets the name of the application on which this service is running.Deprecated.See jms.properties createConnectionPassword.Deprecated.See jms.properties createConnectionUsername.String[]
Gets the current memory profile for the workspace.void
Registers the given activity class schema.void
registerActivityClassSchemas
(ActivityClassSchema[] schemas_) Registers the given activity class schemas.registerPriorities
(PriorityRegistration[] priorities_) Registers the application's priorities.void
setJmsPassword
(String jmsPassword_) Deprecated.See jms.properties createConnectionPassword.void
setJmsUsername
(String jmsUsername_) Deprecated.See jms.properties createConnectionUsername.void
unregisterActivityClassSchema
(String activityClassSchemaLocalId_) Unregisters the given schema.void
unregisterActivityClassSchemas
(String[] activityClassSchemaLocalIds_) Unregisters the given schemas.Methods inherited from interface com.appiancorp.services.ContextSensitiveService
setServiceContext
-
Field Details
-
registerActivityClassSchema$UPDATES
static final boolean registerActivityClassSchema$UPDATES- See Also:
-
registerActivityClassSchemas$UPDATES
static final boolean registerActivityClassSchemas$UPDATES- See Also:
-
unregisterActivityClassSchema$UPDATES
static final boolean unregisterActivityClassSchema$UPDATES- See Also:
-
unregisterActivityClassSchemas$UPDATES
static final boolean unregisterActivityClassSchemas$UPDATES- See Also:
-
getApplicationName$UPDATES
static final boolean getApplicationName$UPDATES- See Also:
-
getWorkspace$UPDATES
static final boolean getWorkspace$UPDATES- See Also:
-
registerPriorities$UPDATES
static final boolean registerPriorities$UPDATES- See Also:
-
getJmsUsername$UPDATES
static final boolean getJmsUsername$UPDATES- See Also:
-
setJmsUsername$UPDATES
static final boolean setJmsUsername$UPDATES- See Also:
-
getJmsPassword$UPDATES
static final boolean getJmsPassword$UPDATES- See Also:
-
setJmsPassword$UPDATES
static final boolean setJmsPassword$UPDATES- See Also:
-
-
Method Details
-
registerActivityClassSchema
void registerActivityClassSchema(ActivityClassSchema schema_) throws IllegalArgumentException, InvalidUserException Registers the given activity class schema. If a schema with the givenlocalId
already exists, that schema will be updated. If no schema with the givenlocalId
exists, a schema will be created. Required fields: Eitherfunction
orjavaClassName
, and also:executionEnvironmentId
,type
,unattended
andlocalId
- Parameters:
schema_
- the schema to register- Throws:
IllegalArgumentException
- if any of the properties of the schema is invalid, or if any required fields are missing. SeeActivityClassSchema
for valid property values.InvalidUserException
- if the username specifed in the Schema does not exists, i.e, the default value for an ACP or ARV of type user or people.ServiceException
- if any system-level error occurs.
-
registerActivityClassSchemas
void registerActivityClassSchemas(ActivityClassSchema[] schemas_) throws IllegalArgumentException, DuplicateIdException, InvalidUserException Registers the given activity class schemas. If any schema with a givenlocalId
already exists, that schema will be updated. If no schema with a givenlocalId
exists, a schema will be created. Required fields: Eitherfunction
orjavaClassName
, and also:executionEnvironmentId
,type
,unattended
andlocalId
- Parameters:
schemas_
- the schemas to register- Throws:
IllegalArgumentException
- the any of the properties of the schema is invalid, or if any required fields are missing. SeeActivityClassSchema
for valid property values.DuplicateIdException
- if any schema, or activity class parameter schema, or activity return variable has the samelocalId
as another in the list. Note that localIds for ACPs and ARVs may be reused in other activity class schemas, but not within the same activity class schemaInvalidUserException
- if the username specifed in the Schema does not exists, i.e, the default value for an ACP or ARV of type user or people.ServiceException
- if any system-level error occurs
-
unregisterActivityClassSchema
void unregisterActivityClassSchema(String activityClassSchemaLocalId_) throws InvalidActivityClassSchemaException, InvalidOperationException Unregisters the given schema.- Parameters:
activityClassSchemaLocalId_
- the local Id of the schema to unregister- Throws:
InvalidActivityClassSchemaException
- if the activity class schema does not existInvalidOperationException
- if the schema is currently in use (that is, if there exist palette items or nodes in process models that use the activity class schema)ServiceException
- if any system-level error occurs
-
unregisterActivityClassSchemas
void unregisterActivityClassSchemas(String[] activityClassSchemaLocalIds_) throws InvalidActivityClassSchemaException, InvalidOperationException Unregisters the given schemas.- Parameters:
activityClassSchemaLocalIds_
- the local Ids of the schemas to unregister- Throws:
InvalidActivityClassSchemaException
- if any activity class schema does not existInvalidOperationException
- if any schema is currently in use (that is, if there exist palette items or nodes in process models that use the activity class schema)ServiceException
- if any system-level error occurs
-
getApplicationName
String getApplicationName()Gets the name of the application on which this service is running.- Returns:
- the name of the application
- Throws:
ServiceException
- if any system-level error occurs
-
getWorkspace
String[] getWorkspace()Gets the current memory profile for the workspace.- Returns:
- array of Strings of length 4 describing memory usage:
- [0]Used - Memory Used by the Server so far for storage
- [1]Allocated - Memory allocated for use. Often if a large data item was allocated by a server and subsequently freed, this value will be large compared to "Used". If nearly all memory allocated is in use, this value will be close to (but always higher than) "Used"
- [2]Mapped - is the space used by memory-mapped files
- [3]Available - is the total available memory for the Server process
- Throws:
ServiceException
- if any system-level error occurs
-
registerPriorities
PriorityRegistration[] registerPriorities(PriorityRegistration[] priorities_) throws IllegalArgumentException Registers the application's priorities. If more than one of the priorities have default set totrue
, the last one registered will be set as the default priority. Theid
,name
,description
,isDefault
andiconId
fields in thePriorityRegistration
bean are required.- Parameters:
priorities_
- The priorities to register.- Returns:
- The registered priorities.
- Throws:
IllegalArgumentException
- If:- Entries of
priorities_
have any incorrect required fields. - Trying to register two or more duplicated priorities.
- None of the priorities have the default property set to true.
- Entries of
NullPointerException
- if any required field of the entries inpriorities_
isnull
, or any of the entry inpriorities_
itself isnull
.
-
getJmsUsername
Deprecated.See jms.properties createConnectionUsername. This method is no longer used.Gets the username that the product will use to connect to JMS Provider.- Returns:
- the username to connect to JMS Provider.
-
setJmsUsername
Deprecated.See jms.properties createConnectionUsername. This method is no longer used.Sets the username that the product will use to connect to JMS Provider.- Parameters:
jmsUsername_
- the username to connect to JMS Provider.
-
getJmsPassword
Deprecated.See jms.properties createConnectionPassword. This method is no longer used.Gets the password that the product will use to connect to JMS Provider.- Returns:
- the password to connect to JMS Provider.
-
setJmsPassword
Deprecated.See jms.properties createConnectionPassword. This method is no longer used.Sets the password that the product will use to connect to JMS Provider.- Parameters:
jmsPassword_
- the password to connect to JMS Provider.
-