Core Modules | |
---|---|
cz.ues.core.artifact | An artifact is a so called smart document, and it is a complex information file. An artifact can be imagined as a text document in which it is possible to undertake many operations - inserting, copying, images, all sorts of links, formatting, etc. Different artifact types exist according to their purpose. For example, organizational units and folders are used for structuring information, roles are used for information competence administration, etc. |
cz.ues.core.attachment | In Unicorn ES it is possible to manage basic operations with attachments. These operations, in principle, limit the life cycle of the attachment - creation, modification, deletion. |
cz.ues.core.container | Unicorn ES allows the user to create organizational units, to manage access to information included in the unit and add new folders thereby increasing the clarity of stored information and shortcuts of any artifact. |
cz.ues.core.content | Artifacts are divided into individual sheets. It is possible to manage these sheets in Unicorn ES. In this text there will be shown basic operations - creation, deletion and renaming of sheets. Other operations are described in the following help texts. |
cz.ues.core.personalrole | Personal Role is the artifact preset in the My Territory of each user. It provides access to My Territory, and is linked to the access roles in all business territories to which the user has access. Personal Role includes user a profile - name and other personal data, contact information, other information such as interests, etc., photo and Universe ID (user's unique numerical identifier in the system). |
cz.ues.core.property | It's possible to add a property to an artifact, in order to draw from it. The property can be any item (number, text, date, etc.). These items are used as entry fields in forms or the values should be workable with the help of automatic script. |
cz.ues.core.qos | The QoS service is used for setting and getting a QoS limits for the access roles or territory. |
cz.ues.core.role | Unicorn ES allows the possibility to create a role. A role is one of the most important features in Unicorn ES. Roles are assigned to Unicorn ES users. Every user has at least one role, i.e. a personal role and other executive roles in which the user works in the system. Thanks to system roles it is possible to define competency for each artifact. This competency is also ensured after competency changes. |
cz.ues.core.security.session | Service representing session of authenticated user. |
cz.ues.core.workflow | Activities are one of the basic building blocks of artifact work flow. You can communicate in the background using activities, or you can plan your own activities above the artifact. |
Subsystem Modules | |
---|---|
cz.ues.myterritory.person | Access to My Territory is only granted to the owner of the personal territory and to any friends they choose to add. |
cz.ues.postman.mail | Postman, integrates Unicorn ES with e-mail interface using POP3 and/or IMAP standard. This integration brings users the possibility to share e-mails across working teams using common functionality of Unicorn ES. |
cz.ues.request.request | Sending a request is like sending an order from the competent role - solving a problem, reporting substandard system operation, new user administration, etc. |
cz.ues.digitalworkspace.digitalworkspace | The Task list is an integral part of Unicorn Universe. It's basically a summary of activities that are delegated to one of your roles or delegated by you to someone else. The list also contains basic information about the subject of the activities, the date when the activity must be completed by, the name of the artifact to which the activity is related and who has delegated the activity. |
UES Core Commands Summary | ||
---|---|---|
Command | Return Value | Description |
UESAccessRole | ||
activateAccess (UESURI accessRoleUri)
|
void
|
This command activates an access role. |
addRoleInterface (UESURI accessRoleUri, UESAccessRoleAddRoleInterface roleInterface)
|
void
|
This command creates new role interface connection to the specified access role. |
create (UESURI locationUri, UESAccessRoleCreate accessRole)
|
UESURI
|
Creates a new access role. |
deactivateAccess (UESURI accessRoleUri)
|
void
|
This command deactivates an access role. |
getAccessRoleList (UESURI territoryUri, UESAccessRoleGetList criteria)
|
UESResultList <UESAccessRoleAttributes, UESAccessRoleGetList>
|
This command returns list of personal access roles in the given location with specified criteria. |
getAttributes (UESURI accessRoleUri)
|
UESAccessRoleAttributes
|
This command returns attributes representing the personal access role specified by the accessRoleUri parameter. |
getRoleInterfaceList (UESURI accessRoleUri, UESAccessRoleGetRoleInterfaceList criteria)
|
UESResultList <UESAccessRoleGetRoleInterfaceListItem, UESAccessRoleGetRoleInterfaceList>
|
Returns list of the role interfaces that are connected to the specified access role. |
removeRoleInterface (UESURI accessRoleUri, UESAccessRoleRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified access role. |
setAttributes (UESURI accessRoleUri, UESAccessRoleSetAttributes accessRole)
|
UESURI
|
Command for setting attributes of an access role. |
UESActivity | ||
create (UESURI parentNodeUri,
UESActivityCreate activity) |
UESURI
|
This command creates a new activity on the specified artifact or activity (sub-activity would be created in this case). |
delete (UESURI activityUri) |
void |
This command deletes an unfinished activity (the command sets the activity to canceled state). |
getActivityList (UESURI parentNodeUri, UESActivityGetActivityList criteria) |
UESResultList <UESActivityAttributes, UESActivityGetActivityList> |
Returns list of the activities and sub activities for the specified artifact or activity |
getAttributes
(UESURI activityUri) |
UESActivityAttributes |
This command returns attributes representing the activity specified by the activityUri parameter. |
getInstanceList (UESURI activityUri, UESActivityGetInstanceList criteria) |
UESResultList <UESActivityAttributes, UESActivityGetInstanceList> |
Returns list of all instances of the recurrent activity. |
getStateHistoryList (UESURI activityUri, UESActivityGetStateHistoryList criteria) |
UESResultList <UESActivityStateAttributes, UESActivityGetStateHistoryList> |
Retrieves the list of set states on a given activity based on provided criteria. |
setAttributes
(UESURI activityUri,
UESActivitySetAttributes activity) |
UESURI |
This command updates some basic attributes of an activity. |
setState
(UESURI activityUri,
UESActivitySetState state) |
void |
This command sets a new state of the specified activity. |
UESActivityAction | ||
create (UESURI entityUri, UESActivityActionCreate activityAction)
|
UESURI
|
Creates a new activity action for the specified entity (activity template or activity instance).
|
delete (UESURI activityActionUri)
|
void
|
Deletes the specified activity action.
|
getActivityActionList (UESURI entityUri, UESActivityActionGetActivityActionList criteria)
|
UESResultList <UESActivityActionAttributes, UESActivityActionGetActivityActionList>
|
Returns a list of activity actions of the specified entity (activity template or activity instance) according to the entered criteria.
|
getAttributes (UESURI activityActionUri)
|
UESActivityActionAttributes
|
Returns attributes of the specified activity action.
|
UESActivityCondition | ||
create (UESURI entityUri, UESActivityConditionCreate activityCondition)
|
java.lang.String
|
Creates a new activity condition for the specified activity template or activity instance.
|
delete (UESURI entityUri, UESActivityConditionGetAttributes activityCondition)
|
void
|
Deletes the specified activity condition.
|
getActivityConditionList (UESURI entityUri, UESActivityConditionGetActivityConditionList criteria)
|
UESResultList <UESActivityConditionAttributes, UESActivityConditionGetActivityConditionList>
|
Returns a list of activity conditions for the specified entity.
|
UESActivityStateTemplate | ||
create (UESURI activityTemplateUri, UESActivityStateTemplateCreate activityStateTemplate)
|
UESURI
|
Creates a new activity state template on the specified activity template.
|
delete (UESURI activityStateTemplateUri)
|
void
|
Deletes the specified activity state template.
|
getActivityStateTemplateList (UESURI activityTemplateUri, UESActivityStateTemplateGetActivityStateTemplateList criteria)
|
UESResultList <UESActivityStateTemplateAttributes, UESActivityStateTemplateGetActivityStateTemplateList>
|
Returns a list of activity state templates for the specified activity template according to entered criteria.
|
getAttributes (UESURI activityStateTemplateUri)
|
UESActivityStateTemplateAttributes
|
Returns attributes of the specified activity state template.
|
setAttributes (UESURI activityStateTemplateUri, UESActivityStateTemplateSetAttributes activityStateTemplate)
|
UESURI
|
Sets attributes of an activity state template.
|
UESActivityTemplate | ||
create (UESURI parentNodeUri, UESActivityTemplateCreate activityTemplate)
|
UESURI
|
Creates a new activity template either on the specified meta artifact or on the specified activity template (in the case of creating a new template for subactivities).
|
delete (UESURI activityTemplateUri)
|
void
|
Deletes the activity template.
|
getActivityTemplateList (UESURI metaArtifactUri, UESActivityTemplateGetActivityTemplateList criteria)
|
UESResultList <UESActivityTemplateAttributes, UESActivityTemplateGetActivityTemplateList>
|
Returns a list of activity templates of the specified meta artifact according to the entered criteria.
|
getAttributes (UESURI activityTemplateUri)
|
UESActivityTemplateAttributes
|
Returns attributes of the specified activity template.
|
setAttributes (UESURI activityTemplateUri, UESActivityTemplateSetAttributes activityTemplate)
|
UESURI
|
Sets basic attributes of the specified activity template.
|
UESAllFromOrganizationalUnitCast | ||
create (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastCreate cast)
|
void
|
Casts a subject (specified in the parameter castedSubjectUri) to the group All From Organizational Unit which is derived from specified organizational unit.
|
delete (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastDelete subject)
|
void
|
Deletes the cast from the system.
|
exists (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastExists cast)
|
java.lang.Boolean
|
Checks whether the subject (specified in the parameter casted_subject_uri) is casted to the group All From Organizational Unit which is derived from the specified organizational unit.
|
getAttributes (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastGetAttributes subject)
|
UESAllFromOrganizationalUnitCastAttributes
|
This command returns attributes of subject cast into the group All From Organizational Unit which is derived from specified organizational unit.
|
getCastList (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastGetCastList criteria)
|
UESResultList <UESAllFromOrganizationalUnitCastAttributes, UESAllFromOrganizationalUnitCastGetCastList>
|
Returns list of casts accord to the group All From Organizational Unit which is derived from the specified organizational unit and optionally accord to the specified cast level and its state.
|
setAttributes (UESURI organizationalUnitUri,
UESAllFromOrganizationalUnitCastSetAttributes cast)
|
void
|
Sets basic attributes of the cast.
|
UESArtifact | ||
create
(UESURI locationUri,
UESArtifactCreate artifact)
|
UESURI
|
Creates an artifact of class Artifact. |
delete (UESURI artifactUri)
|
void
|
This command deletes the specified artifact from the system.
|
export (UESURI artifactUri, UESArtifactExport artifact)
|
UESURI
|
The command exports a artifact to a DataFile, which is saved to the Export Storage.
|
getAttributes
(UESURI artifactUri)
|
UESArtifactAttributes
|
This command gets the attributes of the artifact specified by artifact URI and returns its detail.
|
getExportData (UESURI artifactUri, UESArtifactGetExportData artifact)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getPresentationAttributes (UESURI artifactUri)
|
UESArtifactPresentationAttributes
|
Retrieves presentation settings of an artifact.
|
getReferenceList (UESURI artifactUri, UESArtifactGetReferenceList criteria)
|
UESResultList <UESReferenceEntry, UESArtifactGetReferenceList>
|
This command returns a list of all references from the specified artifact and / or all references to the specified artifact from / to his territory (command does not return references from / to other territories).
|
move (UESURI artifactUri,
UESArtifactMove newLocation)
|
void
|
This command moves an artifact to the new location (folder, organizational unit, meta mode dictionary) in the same territory.
|
setAttributes
(UESURI artifactUri,
UESArtifactSetAttributes artifact)
|
UESURI
|
Command for setting attributes of artifact.
|
setCompetentRole
(UESURI artifactUri,
UESArtifactSetCompetentRole newCompetency)
|
void
|
This command sets a new competent role for an artifact (asynchronously).
|
setPresentationAttributes (UESURI artifactUri, UESArtifactSetPresentationAttributes presentation)
|
UESURI
|
Configures presentation settings of an artifact.
|
setState (UESURI artifactUri,
UESArtifactSetState state)
|
void
|
This command sets a new state of the specified artifact.
|
UESArtifactSearch | ||
query (UESURI aTerritoryUri,
UESArtifactSearchQuery aSearchQuery)
|
UESResultList <UESArtifactSearchResultItem, UESArtifactSearchQuery>
|
Performs search for artifacts with specified criteria.
|
UESArtifactStateTemplate | ||
create (UESURI metaArtifactUri, UESArtifactStateTemplateCreate UESArtifactStateTemplate)
|
UESURI
|
Creates a new artifact state template on the specified meta artifact.
|
delete (UESURI UESArtifactStateTemplateUri)
|
void
|
Deletes the specified artifact state template from the system.
|
getArtifactStateTemplateList (UESURI metaArtifactUri, UESArtifactStateTemplateGetArtifactStateTemplateList criteria)
|
UESResultList <UESArtifactStateTemplateAttributes, UESArtifactStateTemplateGetArtifactStateTemplateList>
|
Returns a list of artifact state templates on the specified meta artifact.
|
getAttributes (UESURI UESArtifactStateTemplateUri)
|
UESArtifactStateTemplateAttributes
|
Returns attributes of the specified artifact state template.
|
setAttributes (UESURI UESArtifactStateTemplateUri, UESArtifactStateTemplateSetAttributes UESArtifactStateTemplate)
|
UESURI
|
Sets attributes of an artifact state template.
|
UESAttachment | ||
create
(UESURI artifactUri,
UESAttachmentCreate attachment)
|
UESURI
|
This command creates a new attachment to the specified artifact.
|
delete (UESURI attachmentUri)
|
void
|
This command deletes the attachment from the system.
|
getAttachmentData
(UESURI attachmentUri)
|
UESAttachmentStreamHandler
|
Command returns stream handler containing data content of the attachment.
|
getAttachmentList
(UESURI artifactUri,
UESAttachmentGetAttachmentList criteria)
|
UESResultList <UESAttachmentAttributes, UESAttachmentGetAttachmentList>
|
Retrieves a UESResult list of attachments for the artifact specified by the artifactUri parameter.
|
getAttributes
(UESURI attachmentUri)
|
UESAttachmentAttributes
|
Returns attributes representing the attachment specified by the attachmentUri attribute.
|
checkIn
(UESURI attachmentUri,
UESAttachmentCheckIn attachment)
|
void
|
This command updates the attached file in the system and unlocks it by default.
|
checkOut
(UESURI attachmentUri,
UESAttachmentCheckOut options)
|
UESAttachmentStreamHandler
|
Command locks the attachment specified by the attachmentUri attribute.
|
setAttributes (UESURI attachmentUri, UESAttachmentSetAttributes attachment)
|
UESURI
|
This command updates basic attributes of an attachment.
|
UESCast | ||
create (UESURI subjectUri,
UESCastCreate cast)
|
void
|
Casts a subject (role or group) to another subject (role or group).
|
delete (UESURI subjectUri,
UESCastDelete subject)
|
void
|
This command deletes the cast from the system.
|
exists (UESURI subjectUri,
UESCastExists cast)
|
java.lang.Boolean
|
This command checks the direct cast existence of an castedSubjectUri in subjectUri.
|
getAccessRoleCastList (UESURI subjectUri, UESCastGetAccessRoleCastList criteria)
|
UESResultList <UESCastAccessRoleAttributes, UESCastGetAccessRoleCastList>
|
Returns list of access roles (personal access roles and uuEEs) casted directly or indirectly to the specified subject (role or group).
|
getAttributes (UESURI subjectUri,
UESCastGetAttributes subject)
|
UESCastAttributes
|
This command returns attributes of one cast.
|
getCastList (UESURI subjectUri,
UESCastGetCastList criteria)
|
UESResultList <UESCastAttributes, UESCastGetCastList>
|
The command returns casts to the specified subject (role or group).
|
setAttributes (UESURI subjectUri,
UESCastSetAttributes cast)
|
void
|
Sets basic attributes of the cast.
|
UESCompany | ||
create (UESURI locationUri, UESCompanyCreate company)
|
UESURI
|
Creates a new company. |
delete (UESURI companyUri)
|
void
|
This command deletes the specified company from the system. |
getAttributes (UESURI companyUri)
|
UESCompanyAttributes
|
This command returns attributes representing the company specified by the companyUri parameter.
|
getEntryList (UESURI companyUri, UESCompanyGetEntryList criteria)
|
UESResultList <UESCompanyEntryAttributes, UESCompanyGetEntryList>
|
This command returns a list of entries (artifacts or shortcuts) enlisted in the specified company. |
setAttributes (UESURI companyUri, UESCompanySetAttributes company)
|
UESURI
|
Command for setting attributes of a company.
|
UESEntityType | ||
getAttributes (UESURI entityType)
|
UESEntityTypeAttributes
|
Reads Entity Type attributes according to given UESURI.
|
getEntityTypeUri (UESURI entity)
|
UESURI
|
Returns UESURI of Entity Type for given object.
|
getChildrenList (UESURI entityType, UESEntityTypeGetChildrenList criteria)
|
UESResultList <UESEntityTypeAttributes, UESEntityTypeGetChildrenList>
|
Returns children of given entity type.
|
isAssignableFrom (UESURI mainEntityType,
UESURI testedEntityType)
|
boolean
|
Checks if Entity Type is assignable from other Entity Type.
|
isInstanceOf (UESURI testedEntity,
UESURI testedEntityType)
|
boolean
|
Checks if some object is instance of given Entity Type.
|
UESFolder | ||
create
(UESURI locationUri,
UESFolderCreate folder)
|
UESURI
|
Creates a folder of class Folder.
|
delete (UESURI folderUri)
|
void
|
This command deletes the specified folder from the system.
|
export (UESURI folderUri, UESFolderExport folder)
|
UESURI
|
The command exports a folder to a DataFile, which is saved to the Export Storage.
|
getAttributes
(UESURI folderUri)
|
UESFolderAttributes
|
Reads folder specified by the folderUri attribute and returns its attributes.
|
getEntryList (UESURI folderUri,
UESFolderGetEntryList criteria)
|
UESResultList <UESFolderEntryAttributes, UESFolderGetEntryList>
|
This command returns a list of entries (artifacts or shortcuts) enlisted in the specified folder (entity type of main entity of the command could be a Folder, Organizational Unit, Territory or Meta Model Dictionary).
|
getExportData (UESURI folderUri, UESFolderGetExportData folder)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
setAttributes (UESURI folderUri,
UESFolderSetAttributes folder)
|
UESURI
|
Command for setting attributes of an folder.
|
UESGroup | ||
addRoleInterface (UESURI groupRoleUri, UESGroupAddRoleInterface group)
|
void
|
This command creates new role interface connection to the specified role. |
cancelActivities (UESURI groupRoleUri, UESGroupCancelActivities group)
|
void
|
This command cancels activities which exist due to group roles for the specified roles. |
create (UESURI locationUri,
UESGroupCreate groupRole)
|
UESURI
|
Creates a new group role.
|
delete (UESURI groupRoleUri)
|
void
|
This command deletes the specified group role from the system.
|
getAttributes (UESURI groupRoleUri)
|
UESGroupAttributes
|
This command returns attributes representing the group role specified by the groupRoleUri parameter.
|
getRoleInterfaceList (UESURI groupRoleUri, UESGroupGetRoleInterfaceList criteria)
|
UESResultList <UESGroupGetRoleInterfaceListItem, UESGroupGetRoleInterfaceList>
|
Returns list of the role interfaces that are connected to the specified role.
|
propagateActivities (UESURI group, UESGroupPropagateActivities castedRoles)
|
void
|
This command propagates activities of the group to its casted roles or casted groups.
|
removeRoleInterface (UESURI roleUri, UESGroupRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified role.
|
setAttributes (UESURI groupRoleUri,
UESGroupSetAttributes groupRole)
|
UESURI
|
Command for setting attributes of a group role.
|
UESLock | ||
create (UESURI resourceUri, UESLockCreate lock)
|
static UESLock
|
Creates new lock. |
getOwnerId ()
|
private static java.lang.String
|
Returns owner ID (in case owner ID does not exists yet new one is generated and stored as retained parameter on PCB). |
isValid ()
|
boolean
|
Checks if lock is valid (e.g. is not expired or was not removed by other process).
|
reallocate (java.lang.Long lockTimeout)
|
void
|
Reallocates lock and thus allows prolonging (or shortening) its expiration time.
|
unlock ()
|
void
|
Unlocks lock.
|
UESMetaAccessRole | ||
addRoleInterface (UESURI metaAccessRoleUri, UESMetaAccessRoleAddRoleInterface roleInterface)
|
void
|
This command creates new role interface connection to the specified meta access role.
|
copy (UESURI sourceMetaArtifactUri, UESMetaAccessRoleCopy metaAccessRole)
|
UESURI
|
Copy a meta access role.
|
export (UESURI metaAccessRoleUri, UESMetaAccessRoleExport metaAccessRole)
|
UESURI
|
The command exports a meta access role to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI metaAccessRoleUri)
|
UESMetaAccessRoleAttributes
|
This command returns attributes representing the meta access role specified by the metaAccessRoleUri parameter.
|
getExportData (UESURI metaAccessRoleUri, UESMetaAccessRoleGetExportData metaAccessRole)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getRoleInterfaceList (UESURI metaAccessRoleUri, UESMetaAccessRoleGetRoleInterfaceList criteria)
|
UESResultList <UESMetaAccessRoleGetRoleInterfaceListItem, UESMetaAccessRoleGetRoleInterfaceList>
|
Returns list of the role interfaces that are added to the specified meta access role.
|
removeRoleInterface(UESURI metaAccessRoleUri, UESMetaAccessRoleRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified meta access role.
|
setAttributes (UESURI metaAccessRoleUri, UESMetaAccessRoleSetAttributes metaAccessRole)
|
UESURI
|
Command for setting attributes of a meta access role.
|
UESMetaArtifact | ||
copy (UESURI sourceMetaArtifactUri, UESMetaArtifactCopy metaArtifact)
|
UESURI
|
Copy a meta artifact.
|
export (UESURI metaArtifactUri, UESMetaArtifactExport metaArtifact)
|
UESURI
|
The command exports a meta artifact to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI metaArtifactUri)
|
UESMetaArtifactAttributes
|
This command returns attributes representing the meta artifact specified by the metaArtifactUri parameter.
|
getDefaultPresentationAttributes (UESURI metaArtifactUri)
|
UESMetaArtifactDefaultPresentationAttributes
|
Retrieves an artifact presentation template.
|
getExportData (UESURI metaArtifactUri, UESMetaArtifactGetExportData metaArtifact)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getPresentationAttributes (UESURI metaArtifactUri)
|
UESMetaArtifactPresentationAttributes
|
Retrieves meta artifact presentation settings.
|
setAttributes (UESURI metaArtifactUri, UESMetaArtifactSetAttributes metaArtifact)
|
UESURI
|
Command for setting attributes of a meta artifact.
|
setDefaultPresentationAttributes (UESURI metaArtifactUri, UESMetaArtifactSetDefaultPresentationAttributes presentation)
|
UESURI
|
Configures an artifact presentation template.
|
setPresentationAttributes (UESURI metaArtifactUri, UESMetaArtifactSetPresentationAttributes presentation)
|
UESURI
|
Configures meta artifact presentation settings.
|
UESMetaGroup | ||
addRoleInterface (UESURI metaGroupUri, UESMetaGroupAddRoleInterface roleInterface)
|
void
|
This command creates new role interface connection to the specified meta group.
|
copy (UESURI sourceMetaArtifactUri, UESMetaGroupCopy metaGroup)
|
UESURI
|
Copy a meta group.
|
export (UESURI metaGroupUri, UESMetaGroupExport metaGroup)
|
UESURI
|
The command exports a meta group to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI metaGroupUri)
|
UESMetaGroupAttributes
|
This command returns attributes representing the meta group specified by the metaGroupUri parameter.
|
getExportData (UESURI metaGroupUri, UESMetaGroupGetExportData metaGroup)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getRoleInterfaceList (UESURI metaGroupUri, UESMetaGroupGetRoleInterfaceList criteria)
|
UESResultList <UESMetaGroupGetRoleInterfaceListItem, UESMetaGroupGetRoleInterfaceList>
|
Returns list of the role interfaces that are added to the specified meta group.
|
removeRoleInterface (UESURI metaGroupUri, UESMetaGroupRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified meta group.
|
setAttributes (UESURI metaGroupUri, UESMetaGroupSetAttributes metaGroup)
|
UESURI
|
Command for setting attributes of a meta group.
|
UESMetaModel | ||
create (UESURI locationUri, UESMetaModelCreate metaModel)
|
UESURI
|
Creates a new meta model. |
delete (UESURI metaModelUri)
|
void
|
This command deletes the specified meta model from the system. |
export (UESURI metaModelUri, UESMetaModelExport metaModel)
|
UESURI
|
The command exports a meta model to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI metaModelUri)
|
UESMetaModelAttributes
|
This command returns attributes representing the meta model specified by the metaModelUri parameter.
|
getEntryList (UESURI metaModelUri, UESMetaModelGetEntryList criteria)
|
UESResultList <UESMetaModelEntryAttributes, UESMetaModelGetEntryList>
|
This command returns a list of entries (artifacts, meta artifacts, meta interfaces, containers, meta model dictionaries or shortcuts) enlisted in the specified meta model dictionary. |
getExportData (UESURI metaModelUri, UESMetaModelGetExportData metaModel)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
setAttributes (UESURI metaModelUri, UESMetaModelSetAttributes metaModel)
|
UESURI
|
Command for setting attributes of a meta model.
|
UESMetaPermission | ||
createMask (UESURI templateUri, UESMetaPermissionCreateMask mask)
|
UESURI
|
This command creates meta permission mask for template.
|
deleteMask (UESURI maskUri)
|
void
|
The command deletes the specified permission mask from the system. When the mask is marked as default, the command fails. |
getAuthorityData (UESURI templateUri, UESMetaPermissionGetAuthorityData options)
|
UESStreamHandler
|
This command returns a template of permission settings data for the specified template and authority.
|
getAuthorityList (UESURI templateUri, UESMetaPermissionGetAuthorityList criteria)
|
UESResultList <UESMetaPermissionGetAuthorityListItem, UESMetaPermissionGetAuthorityList>
|
This command returns a list of authorities who have template of permission on the specified template.
|
getMaskAttributes (UESURI maskUri)
|
UESMetaPermissionGetMaskAttributes
|
This command returns attributes representing the permission mask specified by the permissionMaskUri parameter.
|
getMaskData (UESURI maskUri, UESMetaPermissionGetMaskData options)
|
UESStreamHandler
|
The command returns the complete permission mask settings data.
|
getMaskList (UESURI metaArtifactUri, UESMetaPermissionGetMaskList criteria)
|
UESResultList <UESMetaPermissionGetMaskAttributes, UESMetaPermissionGetMaskList>
|
This command returns a list of permission mask that are placed on the specified meta artifact.
|
getSystemGroupList (UESURI entityUri, UESMetaPermissionGetSystemGroupList criteria)
|
UESResultList <UESMetaPermissionGetSystemGroupAttributes, UESMetaPermissionGetSystemGroupList>
|
This command returns a list of system groups that are defined for the specified template or territory.
|
grant (UESURI templateUri, UESMetaPermissionGrant metaPermission)
|
void
|
The command grants template of permission for the specified template.
|
revoke (UESURI templateUri, UESMetaPermissionRevoke metaPermission)
|
void
|
The command revokes template of permissions for the specified template.
|
setMaskAttributes (UESURI maskUri, UESMetaPermissionSetMaskAttributes mask)
|
UESURI
|
The command sets new attributes of the specified permission mask.
|
setMaskData (UESURI accessRightsMaskUri, UESMetaPermissionSetMaskData maskData)
|
void
|
The command stores a permission mask settings.
|
UESMetaRole | ||
addRoleInterface (UESURI metaRoleUri, UESMetaRoleAddRoleInterface roleInterface)
|
void
|
This command creates new role interface connection to the specified meta role.
|
copy (UESURI sourceMetaArtifactUri, UESMetaRoleCopy metaRole)
|
UESURI
|
Copy a meta role.
|
export (UESURI metaRoleUri, UESMetaRoleExport metaRole)
|
UESURI
|
The command exports a meta role to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI metaRoleUri)
|
UESMetaRoleAttributes
|
This command returns attributes representing the meta role specified by the metaRoleUri parameter.
|
getExportData (UESURI metaRoleUri, UESMetaRoleGetExportData metaRole)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getRoleInterfaceList (UESURI metaRoleUri, UESMetaRoleGetRoleInterfaceList criteria)
|
UESResultList <UESMetaRoleGetRoleInterfaceListItem, UESMetaRoleGetRoleInterfaceList>
|
Returns list of the role interfaces that are added to the specified meta role.
|
removeRoleInterface(UESURI metaRoleUri, UESMetaRoleRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified meta role.
|
setAttributes (UESURI metaRoleUri, UESMetaRoleSetAttributes metaRole)
|
UESURI
|
Command for setting attributes of a meta role.
|
UESOrganizationalUnit | ||
create
(UESURI locationUri,
UESOrganizationalUnitCreate organizationalUnit)
|
UESURI
|
Creates a new organizational unit.
|
delete (UESURI orgUnitUri)
|
void
|
This command deletes the specified organizational unit from the system.
|
getAttributes
(UESURI organizationalUnitUri)
|
UESOrganizationalUnitAttributes
|
This command returns attributes representing the organizational unit specified by the organizationalUnitUri parameter.
|
getEntryList (UESURI organizationalUnitUri,
UESOrganizationalUnitGetEntryList criteria)
|
UESResultList <UESOrganizationalUnitEntryAttributes, UESOrganizationalUnitGetEntryList>
|
This command returns a list of entries (artifacts or shortcuts) enlisted in the specified organizational unit.
|
setAttributes (UESURI organizationalUnitUri,
UESOrganizationalUnitSetAttributes organizationalUnit)
|
UESURI
|
Command for setting attributes of an organizational unit.
|
UESPermission | ||
authorize (UESURI entityUri, UESPermissionAuthorize permission) |
UESPermissionAuthorizeResult
|
Checks wheter the logged user is autorized to the specific use case over the specific entity.
|
getAuthorityData (UESURI entityUri, UESPermissionGetAuthorityData options)
|
UESStreamHandler
|
This command returns a permission settings data for the specified artifact and authority.
|
getAuthorityList (UESURI entityUri, UESPermissionGetAuthorityList criteria)
|
UESResultList <UESPermissionGetAuthorityListItem, UESPermissionGetAuthorityList>
|
This command returns a list of authorities who have permission on the specified artifact.
|
getMaskList (UESURI artifactUri, UESPermissionGetMaskList criteria)
|
UESResultList <UESPermissionGetMaskAttributes, UESPermissionGetMaskList>
|
This command returns a list of permission masks that can be granted on the specified artifact.
|
getSystemGroupList (UESURI artifactUri, UESPermissionGetSystemGroupList criteria)
|
UESResultList <UESPermissionGetSystemGroupAttributes, UESPermissionGetSystemGroupList>
|
This command returns a list of system groups that are defined for the specified artifact.
|
grant (UESURI entityUri, UESPermissionGrant permission)
|
void
|
The command grants permission for the specified artifact and its aggregated objects.
|
revoke (UESURI entityUri, UESPermissionRevoke permission)
|
void
|
The command revokes permissions for the specified artifact and its aggregated objects.
|
UESPersonalRole | ||
getArtifactPresentationAttributes (UESURI personalRoleUri)
|
UESPersonalRoleArtifactPresentationAttributes
|
Retrieves user settings of artifact presentation.
|
getProfileAttributes (UESURI personalRoleUri)
|
UESProfileAttributes
|
This command returns profile information of the user.
|
getTerritoryList (UESURI personalRoleUri,
UESPersonalRoleGetTerritoryList criteria)
|
UESResultList <UESTerritoryAttributes, UESPersonalRoleGetTerritoryList>
|
This command returns a list of territories the personal role has access to.
|
setArtifactPresentationAttributes (UESURI personalRoleUri, UESPersonalRoleSetArtifactPresentationAttributes attributes)
|
UESURI
|
Configures user settings of artifact presentation.
|
setProfileAttributes (UESURI personalRoleUri, UESProfileSetAttributes profile)
|
UESURI
|
Sets user's profile attributes.
|
UESProcess | ||
completed (UESMessage message)
|
void
|
Method marks use case as completed.
|
completedFinal (UESMessage message)
|
void
|
Method marks use case as finished.
|
completedWithError (UESMessage message, java.lang.Exception exception)
|
void
|
Method marks use case as failed.
|
completedWithWarning (UESMessage message, java.lang.Exception exception)
|
void
|
Method marks use case as completed with warnings.
|
fireActiveEvent (UESProcessEvent processEvent)
|
void
|
Method is used for invocation of general active process event (alternative to using methods info, warning and progress).
|
fireCompletedEvent (UESProcessEvent processEvent)
|
void
|
Method is used for invocation of general completed process event (alternative to using methods completed, completedWithWarning, completedWithError and completedFinal).
|
getCurrentProcessUri ()
|
UESURI
|
Returns UESURI of currently active process or null if there is no active process.
|
getResult (long timeout, java.lang.String... eventCodes)
|
UESProcessResult
|
Method searches all subprocesses of recent use case process and returns first result matching provided event codes within given timeout.
|
info (UESMessage message)
|
void
|
Method send info notification from use case.
|
isProcessEventToActivityPropagationEnabled ()
|
boolean
|
Method used to read configuration of propagation of process events to activity from which was process launched.
|
progress (UESMessage message)
|
void
|
Method is used for informing user of use case progress.
|
setProcessEventToActivityPropagationEnabled (boolean enabled)
|
void
|
Method used to configure propagation of process events to activity from which was process launched.
|
start (UESMessage message, int totalSteps)
|
void
|
Method should be called on the beginning of use case.
|
warning (UESMessage message, java.lang.Exception exception)
|
void
|
Method send warning notification from use case.
|
UESProperty | ||
create
(UESURI parentNodeUri,
UESPropertyCreate property)
|
UESURI
|
This command creates a new property on the specified artifact or in the specified property collection.
|
createCollection (UESURI parentNodeUri,
UESPropertyCreateCollection propertyCollection)
|
UESURI
|
This command creates a new property collection on the specified artifact or in the specified property collection.
|
delete (UESURI propertyUri)
|
void
|
This command deletes the property from the system.
|
deleteCollection (UESURI collectionUri, UESPropertyDeleteCollection options)
|
void
|
This command deletes the property collection from the system.
|
getAttributes
(UESURI propertyUri)
|
UESPropertyAttributes
|
Returns attributes representing the artifact property specified by the propertyUri attribute.
|
getCollectionAttributes (UESURI collectionUri)
|
UESPropertyCollectionAttributes
|
This command returns attributes representing the property collection specified by the collectionUri parameter.
|
getEntryList(UESURI parentNodeUri,
UESPropertyGetEntryList criteria)
|
UESResultList <UESPropertyEntryAttributes, UESPropertyGetEntryList>
|
This command returns a list of entries (properties or property collections) enlisted in the specified property collection or on the specified artifact (properties from the artifact root property collection are returned in that case).
|
getValue
(UESURI propertyUri)
|
<T> T
|
This command returns a value on the specified property.
|
move (UESURI propertyUri,
UESPropertyMove newLocation)
|
void
|
Moves the specified property to a new location in same artifact in which the property is.
|
moveCollection (UESURI collectionUri,
UESPropertyMoveCollection newLocation)
|
void
|
This command moves a property collection to the new location in the same artifact.
|
setAttributes (UESURI propertyUri,
UESPropertySetAttributes property)
|
UESURI
|
This command sets attributes of the specified property.
|
setCollectionAttributes (UESURI collectionUri,
UESPropertySetCollectionAttributes propertyCollection)
|
UESURI
|
This command sets attributes of the specified property collection.
|
setValue
(UESURI propertyUri, java.lang.Object value)
|
void
|
This command sets a new value on the specified property.
|
UESPropertyTemplate | ||
create (UESURI parentNodeUri, UESPropertyTemplateCreate propertyTemplate)
|
UESURI
|
Creates a new property template on the specified Meta Artifact or in the specified property template group.
|
createCollection (UESURI parentNodeUri, UESPropertyTemplateCollectionCreate propertyCollTemplate)
|
UESURI
|
Creates a new property template collection on the specified Meta Artifact or in the specified property collection template.
|
delete (UESURI propertyTemplateUri)
|
void
|
Deletes the property template from the system.
|
deleteCollection (UESURI collTemplateUri, UESPropertyTemplateDeleteCollection options)
|
void
|
Deletes the specified property collection template.
|
getAttributes (UESURI propertyTemplateUri)
|
UESPropertyTemplateAttributes
|
Returns attributes representing the specified property template.
|
getCollectionAttributes (UESURI collectionTemplateUri)
|
UESPropertyTemplateCollectionAttributes
|
Returns attributes of the specified property collection template.
|
getEntryList(UESURI parentNodeUri,
UESPropertyTemplateGetEntryList criteria)
|
UESResultList <UESPropertyTemplateEntryAttributes, UESPropertyTemplateGetEntryList>
|
Returns a list of entries (property templates or property template collections) enlisted in the specified property template collection or on the specified Meta Artifact (property template entries from the Meta Artifact root property template collection are returned in that case).
|
getValue (UESURI propertyTemplateUri)
|
<T> T
|
Returns the value of the given property template of the corresponding type.
|
move (UESURI propertyTemplateUri, UESPropertyTemplateMove newLocation)
|
void
|
Moves a property template to the new location (see UESPropertyTemplateMove.parentNodeUri ) on the same artifact.
|
moveCollection (UESURI collectionUri, UESPropertyTemplateMoveCollection newLocation)
|
void
|
Moves a property template collection to the new location (see UESPropertyTemplateMoveCollection.parentNodeUri ) on the same Meta Artifact.
|
setAttributes (UESURI propertyTemplateUri, UESPropertyTemplateSetAttributes propertyTemplate)
|
UESURI
|
Sets basic attributes of the specified property template.
|
setCollectionAttributes (UESURI collTemplateUri, UESPropertyTemplateSetCollectionAttributes propertyCollTemplate)
|
UESURI
|
Modifies basic attributes of the property collection template specified in collTemplateUri.
|
setValue (UESURI propertyTemplateUri, java.lang.Object value)
|
void
|
Sets a new value on the specified property template.
|
UESQoS | ||
getAccessRoleQoS (UESURI accessRoleUri)
|
UESAccessRoleGetQoS
|
Returns a DTO representing QoS for a specific access role.
|
getTerritoryQoS (UESURI territoryUri)
|
UESTerritoryGetQoS
|
Returns a DTO representing QoS for a specific territory.
|
setAccessRoleQoS (UESURI accessRoleUri, UESAccessRoleSetQoS setQoS)
|
void
|
Sets QoS for a specific access role.
|
setTerritoryQoS (UESURI territoryUri, UESTerritorySetQoS setQoS)
|
void
|
Sets QoS for a specific territory.
|
UESRole | ||
addRoleInterface (UESURI roleUri, UESRoleAddRoleInterface roleInterface)
|
void
|
This command creates new role interface connection to the specified role.
|
create (UESURI locationUri,
UESRoleCreate role)
|
UESURI
|
Creates a new role.
|
delete (UESURI roleUri)
|
void
|
This command deletes the specified role from the system.
|
getArtifactList (UESURI roleUri, UESRoleGetArtifactList criteria)
|
UESResultList <UESRoleGetArtifactListItem, UESRoleGetArtifactList>
|
This command returns a list of entries representing the artifacts for that the specified role is competent.
|
getAttributes (UESURI roleUri)
|
UESRoleAttributes
|
This command returns attributes representing the role specified by the roleUri parameter.
|
getRoleInterfaceList (UESURI roleUri, UESRoleGetRoleInterfaceList criteria)
|
UESResultList <UESRoleGetRoleInterfaceListItem, UESRoleGetRoleInterfaceList>
|
Returns list of the role interfaces that are connected to the specified role.
|
removeRoleInterface (UESURI roleUri, UESRoleRemoveRoleInterface roleInterface)
|
void
|
The command removes role interface connection from the specified role.
|
setAttributes (UESURI roleUri,
UESRoleSetAttributes role)
|
UESURI
|
Command for setting attributes of a role.
|
UESRoleInterface | ||
addMetaArtifact (UESURI roleInterfaceUri, UESRoleInterfaceAddMetaArtifact metaArtifact)
|
void
|
The command creates new meta artifact connection to the specified role interface.
|
create (UESURI locationUri, UESRoleInterfaceCreate roleInterface)
|
UESURI
|
Creates a new role interface.
|
delete (UESURI roleInterfaceUri)
|
void
|
This command deletes the specified role interface from the system.
|
export (UESURI roleInterfaceUri, UESRoleInterfaceExport roleInterface)
|
UESURI
|
The command exports a role interface to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI roleInterfaceUri)
|
UESRoleInterfaceAttributes
|
This command returns attributes representing the role interface specified by the roleInterfaceUri parameter.
|
getExportData (UESURI roleInterfaceUri, UESRoleInterfaceGetExportData roleInterface)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getMetaArtifactList (UESURI roleInterfaceUri, UESRoleInterfaceGetMetaArtifactList criteria)
|
UESResultList <UESRoleInterfaceGetMetaArtifactListItem, UESRoleInterfaceGetMetaArtifactList>
|
Returns list of the meta artifacts that are connected to the specified role interface.
|
getRoleList (UESURI roleInterfaceUri, UESRoleInterfaceGetRoleList criteria)
|
UESResultList <UESRoleInterfaceGetRoleListItem, UESRoleInterfaceGetRoleList>
|
Returns list of the meta artifacts that are connected to the specified role interface.
|
removeMetaArtifact (UESURI roleInterfaceUri, UESRoleInterfaceRemoveMetaArtifact metaArtifact)
|
void
|
The command removes meta artifact connection from the specified role interface.
|
setAttributes (UESURI roleInterfaceUri, UESRoleInterfaceSetAttributes roleInterface)
|
UESURI
|
Command for setting attributes of a role interface.
|
UESRoleSearch | ||
query (UESURI aTerritoryUri,
UESRoleSearchQuery aSearchQuery)
|
UESResultList <UESRoleSearchResultItem, UESRoleSearchQuery>
|
Performs a search for roles with specified criteria.
|
UESScript | ||
exec (UESURI mainEntityUri, UESScriptExec parameters)
|
UESURI
|
Executes script based on main entity URI. |
UESSearch | ||
exists (UESURI objectUri)
|
boolean
|
This command checks the existence of an artifact or an aggregated object in the system.
|
UESSession | ||
getAccessRole (UESURI territoryUri)
|
UESURI
|
Returns access role URI of authenticated user in given territory.
|
getInitiatorAccessRole (UESURI territoryUri)
|
UESURI
|
Returns access role URI of user who initiated session in given territory.
|
getInitiatorPersonalRole ()
|
UESURI
|
Returns personal role of user who initiated session (did the first login).
|
getPersonalRole ()
|
UESURI
|
Returns personal role URI of authenticated user.
|
UESSheet | ||
create
(UESURI artifactUri,
UESSheetCreate sheet)
|
UESURI
|
Command creates a new sheet in the specified artifact.
|
delete (UESURI sheetUri)
|
void
|
Deletes the sheet from the system.
|
deleteComponent (UESURI sheetUri,
UESSheetDeleteComponent component)
|
void
|
Deletes specified component from the sheet.
|
deleteVersion (UESURI sheetUri, UESSheetDeleteVersion version)
|
void
|
Deletes the version from the system.
|
getAttributes
(UESURI sheetUri)
|
UESSheetAttributes
|
Returns attributes representing the sheet specified by the sheetUri attribute.
|
getComponentData (UESURI sheetUri,
UESSheetGetComponentData component)
|
UESSheetStreamHandler
|
Returns the content of specified sheet component in the BB code format.
|
getSheetData
(UESURI sheetUri,
UESSheetGetSheetData options)
|
UESSheetStreamHandler
|
Returns content from sheet specified by sheetUri .
|
getSheetList (UESURI artifactUri, UESSheetGetSheetList sheetCriteria)
|
UESResultList <UESSheetAttributes, UESSheetGetSheetList>
|
Returns list of sheets specified by the artifactUri attribute.
|
getVersionAttributes (UESURI sheetUri, UESSheetGetVersionAttributes versionAttributes)
|
UESSheetVersionAttributes
|
Returns attributes of given sheet version.
|
getVersionList (UESURI sheetUri, UESSheetGetVersionList versionCriteria)
|
UESResultList <UESSheetVersionAttributes, UESSheetGetVersionList>
|
This command returns a list of sheet versions of the specified sheet.
|
checkIn
(UESURI sheetUri,
UESSheetCheckIn sheet)
|
void
|
This command changes the content of the public sheet version and unlocks it by default.
|
checkOut
(UESURI sheetUri,
UESSheetCheckOut options)
|
UESSheetStreamHandler
|
This command locks the sheet for further modification, locks the given sheet of artifact.
|
publish (UESURI sheetUri)
|
void
|
Publishes private version and opens the locked sheet.
|
replaceComponent (UESURI sheetUri,
UESSheetReplaceComponent component)
|
java.util.List <java.lang.String>
|
Replaces specified sheet component with given content.
|
setAttributes (UESURI sheetUri,
UESSheetSetAttributes sheet)
|
UESURI
|
This command updates basic attributes of an sheet.
|
unlock (UESURI sheetUri)
|
void
|
Unlocks the specified sheet.
|
UESSheetTemplate | ||
create (UESURI marUri, UESSheetTemplateCreate sheetTemplate)
|
UESURI
|
This command creates a new sheet template on the specified meta-artifact.
|
delete (UESURI sheetTemplateUri)
|
void
|
Command deletes the sheet template from the system.
|
getAttributes (UESURI sheetTemplateUri)
|
UESSheetTemplateAttributes
|
Returns attributes representing the sheet template specified by the sheetTemplateUri attribute.
|
getData (UESURI sheetTemplateUri, UESSheetTemplateGetData options)
|
UESSheetStreamHandler
|
Command returns the content of the sheet template in a stream.
|
getSheetTemplateList (UESURI marUri, UESSheetTemplateGetSheetTemplateList criteria)
|
UESResultList <UESSheetTemplateAttributes, UESSheetTemplateGetSheetTemplateList>
|
Returns a list of sheet templates on the specified Meta Artifact.
|
checkIn (UESURI sheetTemplateUri, UESSheetTemplateCheckIn sheetTemplate)
|
void
|
Command replaces the content of the specified sheet template and unlock it by default.
|
setAttributes (UESURI sheetTemplateUri, UESSheetTemplateSetAttributes sheetTemplate)
|
UESURI
|
Command updates basic attributes of the sheet template.
|
UESShortcut | ||
create (UESURI locationUri,
UESShortcutCreate shortcut)
|
UESURI
|
This command creates a new shortcut for the specified artifact.
|
delete (UESURI shortcutUri)
|
void
|
This command deletes the shortcut from the system.
|
getAttributes (UESURI shortcutUri)
|
UESShortcutAttributes
|
This command returns attributes representing the shortcut specified by the shortcutUri parameter.
|
getShortcutList (UESURI artifactUri,
UESShortcutGetShortcutList criteria)
|
UESResultList <UESShortcutAttributes, UESShortcutGetShortcutList>
|
This command returns a list of shortcuts to the specified artifact.
|
relocate (UESURI shortcutUri,
UESShortcutRelocate shortcut)
|
UESURI
|
This command relocates the shortcut to the new location.
|
setAttributes (UESURI shortcutUri,
UESShortcutSetAttributes shortcut)
|
UESURI
|
This command updates some basic attributes of a shortcut.
|
UES MyTerritory Command Summary | ||
---|---|---|
Command | Return Value | Description |
UESFriend | ||
activateAccess (UESURI friendUri)
|
void
|
Deprecated.
This command activates an existing friend.
|
create (UESURI personalTerritoryUri, UESFriendCreate friend)
|
UESURI
|
Deprecated.
Creates a new friend.
|
deactivateAccess (UESURI friendUri)
|
void
|
Deprecated.
This command deactivates a friend.
|
getAttributes (UESURI friendUri)
|
UESFriendAttributes
|
Deprecated.
This command returns attributes representing the friend specified by the friendUri parameter.
|
setAttributes (UESURI friendUri, UESFriendSetAttributes friend)
|
UESURI
|
Deprecated.
Command for setting attributes of a friend.
|
UES Postman Command Summary | ||
---|---|---|
Command | Return Value | Description |
UESMail | ||
createArtifactFromEmail (UESURI competentRoleUri,
UESMailCreateArtifactFromEmail artifactMail)
|
void
|
Creates a new artifact from an email.
|
getEmailCapableRoleList (UESURI territoryUri,
UESMailGetEmailCapableRoleList criteria)
|
UESResultList <UESMailRoleAttributes, UESMailGetEmailCapableRoleList>
|
This command returns a list of all roles capable of creating a new artifact from an email.
|
UES Request Command Summary | ||
---|---|---|
Command | Return Value | Description |
UESRequest | ||
delete (UESURI requestUri)
|
void
|
This command deletes the specified request from the system.
|
getAttributes (UESURI requestUri)
|
UESRequestAttributes
|
This command returns attributes representing the request specified by the requestUri parameter.
|
setAttributes (UESURI requestUri, UESRequestSetAttributes request)
|
UESURI
|
This command sets attributes to the specified request.
|
UES Digital Workspace Command Summary | ||
---|---|---|
Command | Return Value | Description |
UESCalendar | ||
getBusyTimeList (UESURI roleUri, UESCalendarGetBusyTimeList criteria)
|
UESResultList <UESCalendarBusyTimeAttributes, UESCalendarGetBusyTimeList>
|
Returns list of digital workspace calendar blocks for the specified user according to the specified parameters timeMin and timeMax.
|
UESDigitalWorkspace | ||
getActiveRecordList (UESURI roleUri, UESDigitalWorkspaceGetActiveRecordList criteria)
|
UESResultList <UESDigitalWorkspaceRecordAttributes, UESDigitalWorkspaceGetActiveRecordList>
|
The command returns list of active digital workspace records enlisted in the specified role's digital workspace (entity type of main entity of the command could be a Role or Access Role).
|
getArchiveRecordList (UESURI roleUri, UESDigitalWorkspaceGetArchiveRecordList criteria)
|
UESResultList <UESDigitalWorkspaceRecordAttributes, UESDigitalWorkspaceGetArchiveRecordList>
|
The command returns list of finished digital workspace records enlisted in the specified role's digital workspace (entity type of main entity of the command could be a Role or Access Role).
|
UES System Catalog Command Summary | ||
---|---|---|
Command | Return Value | Description |
App | ||
create (UESURI locationUri, AppCreate app)
|
UESURI
|
Creates a new application.
|
getAttributes (UESURI appUri)
|
AppAttributes
|
This command returns attributes representing the application specified by the appUri parameter.
|
getEntryList (UESURI appUri, AppGetEntryList criteria)
|
UESResultList <AppEntryAttributes, AppGetEntryList>
|
This command returns a list of entries (artifacts or shortcuts) enlisted in the specified application.
|
setAttributes (UESURI appUri, AppSetAttributes app)
|
UESURI
|
Command for setting attributes of an application.
|
AppBox | ||
create (UESURI locationUri, AppBoxCreate appBox)
|
UESURI
|
Creates a new application box.
|
getAttributes (UESURI appBoxUri)
|
AppBoxAttributes
|
This command returns attributes representing the application box specified by the appBoxUri parameter.
|
getEntryList (UESURI appBoxUri, AppBoxGetEntryList criteria)
|
UESResultList <AppBoxEntryAttributes, AppBoxGetEntryList>
|
This command returns a list of entries (artifacts or shortcuts) enlisted in the specified application box.
|
setAttributes (UESURI appBoxUri, AppBoxSetAttributes appBox)
|
UESURI
|
Command for setting attributes of an application box.
|
Command | ||
create (UESURI locationUri, CommandCreate command)
|
UESURI
|
The command creates a command in a specified meta model.
|
delete (UESURI commandUri)
|
void
|
The command deletes the specified command from the system.
|
getAttributes (UESURI commandUri)
|
CommandAttributes
|
This command returns attributes representing the command specified by the commandUri parameter.
|
setAttributes (UESURI commandUri, CommandSetAttributes command)
|
UESURI
|
The command for setting attributes of a specified command.
|
MetaUseCaseRealization | ||
copy (UESURI sourceMetaArtifactUri, MetaUseCaseRealizationCopy metaUseCaseRealization)
|
UESURI
|
Copy a meta use case realization.
|
getAttributes (UESURI metaUseCaseRealizationUri)
|
MetaUseCaseRealizationAttributes
|
This command returns attributes representing the meta use case realization specified by the metaUseCaseRealizationUri parameter.
|
setAttributes (UESURI metaUseCaseRealizationUri, MetaUseCaseRealizationSetAttributes metaUseCaseRealization)
|
UESURI
|
The command for setting attributes of a specified meta use case realization.
|
UseCase | ||
create (UESURI metaArtifactUri, UseCaseCreate useCase)
|
UESURI
|
The command creates a use case in a specified meta artifact.
|
delete (UESURI useCaseUri)
|
void
|
The command deletes the specified use case from the system.
|
getAttributes (UESURI useCaseUri)
|
UseCaseAttributes
|
This command returns attributes representing the use case specified by the useCaseUri parameter.
|
getOptions (UESURI useCaseUri, UseCaseGetOptions options)
|
UESStreamHandler
|
The command returns options of the specified use case.
|
getUseCaseList (UESURI metaArtifactUri, UseCaseGetUseCaseList criteria)
|
UESResultList <UseCaseAttributes, UseCaseGetUseCaseList>
|
Returns list of the use cases that are defined on the specified meta artifact.
|
setAttributes (UESURI useCaseUri, UseCaseSetAttributes useCase)
|
UESURI
|
The command sets attributes on specified use case according to useCaseUri.
|
setOptions (UESURI useCaseUri, UseCaseSetOptions options)
|
void
|
The command sets options of the specified use case.
|
VisualUseCase | ||
create (UESURI locationUri, VisualUseCaseCreate visualUseCase)
|
UESURI
|
The command creates a visual use case in a specified meta model.
|
delete (UESURI visualUseCaseUri)
|
void
|
The command deletes the specified visual use case from the system.
|
export (UESURI visualUseCaseUri, VisualUseCaseExport visualUseCase)
|
UESURI
|
The command exports a visual use case to a DataFile, which is saved to the Export Storage.
|
getAttributes (UESURI visualUseCaseUri)
|
VisualUseCaseAttributes
|
This command returns attributes representing the visual use case specified by the visualUseCaseUri parameter.
|
getData (UESURI visualUseCaseUri)
|
UESStreamHandler
|
The command returns content of first attachment which is used as data for visual use case.
|
getExportData (UESURI visualUseCaseUri, VisualUseCaseGetExportData visualUseCase)
|
UESStreamHandler
|
The command returns a data file generated by the export command.
|
getOptions (UESURI visualUseCaseUri, VisualUseCaseGetOptions options)
|
UESStreamHandler
|
The command returns options of the specified use case.
|
getUseCaseList (UESURI visualUseCaseUri, VisualUseCaseGetUseCaseList criteria)
|
UESResultList <VisualUseCaseGetUseCaseListItem, VisualUseCaseGetUseCaseList>
|
Returns list of the use cases that are connected to the specified visual use case.
|
setAttributes (UESURI visualUseCaseUri, VisualUseCaseSetAttributes visualUseCase)
|
UESURI
|
The command for setting attributes of a specified visual use case.
|
setOptions (UESURI visualUseCaseUri, VisualUseCaseSetOptions options)
|
void
|
The command sets options of the specified visual use case.
|