|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcOrganizationOperationsIntf
Method Summary | |
---|---|
void |
addAdministrator(long plOrganizationKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds a group to the list of groups that have authorization access over the specified object. |
void |
addObjectAllowed(long plOrganizationKey, long plObjectKey, boolean pbSelfServiceable) Deprecated. |
void |
addObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) Assigns an object to be allowed for an organization. |
boolean |
canResourceBeProvisioned(long orgKey, long objectKey) Determines if a resource can be provisioned to an organization or not. |
long |
createOrganization(java.util.Map phMapping) Creates an organization in Xellerate with the specified attributes. |
void |
deleteOrganization(long plOrgKey) Deletes a specified organization |
void |
deleteOrganizations(long[] palOrgKeys) Deletes a list of organizations |
void |
disableOrganization(long plOrgKey) Disables an enabled organization in Xellerate |
void |
disableOrganizations(long[] palOrgKeys) Disables a list of enabled organizations in Xellerate |
void |
enableOrganization(long plOrgKey) Enables a disabled organization in Xellerate |
void |
enableOrganizations(long[] palOrgKeys) Enables a list of disabled organizations in Xellerate |
Thor.API.tcResultSet |
findOrganizations(java.util.Map phAttributeList) Returns a list of organizations (in the form of a tcResultSet) that matches the provided attribute list. |
Thor.API.tcResultSet |
findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list. |
Thor.API.tcResultSet |
findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) Returns a list of organizations (in the form of a list of tcDataRecord) that matches the provided attribute list. |
Thor.API.tcResultSet |
getAdministrators(long plOrganizationKey) Returns a list of groups that are administrative groups of the specified organization |
Thor.API.tcResultSet |
getAdministrators(java.util.Map searchCriteria) Returns a list of groups that are administrative groups of the specified organization |
Thor.API.tcResultSet |
getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) This object returns a resultset of the object available for the given encoded value. |
Thor.API.tcResultSet |
getListOfUsers(long plOrganizationKey) Returns a list of users (in the form of a tcResultSet) that are in the specified organization |
long |
getNumberOfSubOrgs(long plOrgKey) Returns the number of sub-organization of a specified Organization |
long |
getNumberOfUsers(long plOrgKey) Returns the number of users associated to a specified organization |
Thor.API.tcResultSet |
getObjects(long orgKey) Gets a list of all the objects that have been provisioned for the given organization. |
Thor.API.tcResultSet |
getObjectsAllowed(long orgKey) Returns the list of allowed objects for a given organization |
Thor.API.tcResultSet |
getSubOrganizations(long plOrganizationKey) Returns a list of organizations (in the form of a tcResultSet) that are child organizations of the specified organization |
Thor.API.tcResultSet |
getUnassignedAdministrators(long plOrgKey) Returns a list groups of that are not assigned as administartive groups for an organization. |
Thor.API.tcResultSet |
getUnassignedAdministrators(java.util.Map searchCriteria) Returns a list groups of that are not assigned as administartive groups for specified organization. |
Thor.API.tcResultSet |
getUnassignedResources(long plOrgKey) Returns a list resource objects that are not assigned for the given organization. |
Thor.API.tcResultSet |
getUnassignedSubOrganizations(long plOrgKey) Returns a list organizations that are not assigned as suborganizations for the given organization. |
Thor.API.tcResultSet |
getUnassignedUsers(long plOrgKey) Returns a list users that are not assigned for the given organization. |
void |
moveOrganizations(long[] palOrgKeys, long plTargetOrgKey) Makes a list of organizations as sub-organization of a target organization |
void |
moveUsers(long[] palUserKeys, long plTargetOrgKey) moves the given users to a specified organization |
long |
provisionObject(long plOrgKey, long plObjectKey) Provision an object for an organization directly without going through a request. |
long |
provisionObject(long plOrgKey, long plObjectKey, java.util.Map phMapping) Provision an object for an organization directly without going through a request including any specific parameters |
com.thortech.xl.vo.ResourceData |
provisionResource(long plOrgKey, long plObjectKey) Provision an object for an organization directly without going through a request. |
void |
removeAdministrator(long plOrgKey, long plGroupKey) Removes a given administrator from the specified organization |
void |
removeObjectAllowed(long plOrgKey, long plObjectKey) Removes the Object allowed to the given organization |
void |
updateAdministrator(long plOrgKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Updates a group that has administrative access over a specified organization. |
void |
updateObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) Updates the Object allowed servicesable information for the given organization |
void |
updateOrganization(long orgKey, java.util.Map attributes) Updates organization information based on the attribute that are passed to this method |
void |
updateOrganization(Thor.API.tcResultSet poOrgResultSet, java.util.Map phAttributeList) Updates an Organiztion in Xellerate. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
Thor.API.tcResultSet findOrganizations(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- The Key of the organization whose users are to be retrievedtcAPIException
Thor.API.tcResultSet findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList) throws tcAPIException, tcAPIException
phAttributeList
- An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).pasFieldList
- The list of fields (specified as column codes from the Xellerate metadata) that should be in the returned result set.tcAPIException
Thor.API.tcResultSet findOrganizationsFiltered(java.util.Map phAttributeList, java.lang.String[] pasFieldList, int startRow, int pageSize, java.lang.String[] order, boolean ascendingOrder) throws tcAPIException, tcAPIException
paoAttributeList
- An array of tcMapping objects, each object holding the attribute-value pairs to match the group against. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to base the search on. The values could include wild cards (%).pasFieldList
- The list of fields (specified as column codes from the Xellerate metadata) that should be in the returned result set.startRow
- The starting row of the resultpageSize
- The page size (how many rows to return)order
- The order in which the result set is based since only a subset of the whole matching set is returned, the caller will not be able to sort accurately with only that subset.ascendingOrder
- - a boolean value if the sorting is to be ascending or descendingtcAPIException
Thor.API.tcResultSet getAdministrators(long plOrganizationKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrganizationKey
- The Key of the organization whose administrative groups are to be retrievedtcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getListOfUsers(long plOrganizationKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrganizationKey
- The Key of the organization whose users are to be retrievedtcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getSubOrganizations(long plOrganizationKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrganizationKey
- The Key of the organization whose sub-organizations are to be retrievedtcAPIException
tcOrganizationNotFoundException
long createOrganization(java.util.Map phMapping) throws tcDuplicateOrganizationException, tcAttributeMissingException, tcInvalidAttributeException, tcInvalidNameException, tcAPIException, tcAPIException
phMapping
- A map of name-value pairs, each entry representing an attribute to be set for the organization.tcDuplicateOrganizationException
tcAttributeMissingException
tcInvalidAttributeException
tcAPIException
tcInvalidNameException
void addAdministrator(long plOrganizationKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcOrganizationNotFoundException, tcGroupNotFoundException, tcAPIException
plOrganizationKey
- The Key of the organization to which an administrator group is to be assignedplGroupKey
- String holding the Group Key (corresponds to value in the UGP_KEY column)pbWrite
- Whether the group has Write permissionspbDelete
- Whether the group has Delete permissionstcAPIException
tcOrganizationNotFoundException
tcGroupNotFoundException
void addObjectAllowed(long plOrganizationKey, long plObjectKey, boolean pbSelfServiceable) throws tcOrganizationNotFoundException, tcObjectNotFoundException, tcAPIException, tcAPIException
plOrganizationKey
- The key of the organization to which the object is to be assignedplObjectKey
- The key of the object to be assignedpbSelfServiceable
- Specifies whether or not the object is self serviceabletcOrganizationNotFoundException
tcObjectNotFoundException
tcAPIException
void addObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) throws tcAPIException, tcOrganizationNotFoundException, tcObjectNotFoundException, tcInvalidAttributeException, tcAPIException
plOrgKey
- the organization keyplObjectKey
- the object keyphAttributeList
- Map containing the serviceable flag for the object allowedtcAPIException
tcOrganizationNotFoundException
tcObjectNotFoundException
tcInvalidAttributeException
void updateOrganization(Thor.API.tcResultSet poOrgResultSet, java.util.Map phAttributeList) throws tcAPIException, tcOrganizationNotFoundException, tcStaleDataUpdateException, tcAPIException
poOrgResultSet
- A result set containing at the minimum the Organization key and the row version of the Organization record to update. Note that if the result set contains multiple Organization, only the first Organization within the result set will be updated.phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to set/modify for this Organization. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes of the columns to set. User defined fields may be included in this attribute list as well.tcAPIException
tcOrganizationNotFoundException
tcStaleDataUpdateException
void updateOrganization(long orgKey, java.util.Map attributes) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
orgKey
- the organization keyattributes
- a map of updated attributestcAPIException
tcOrganizationNotFoundException
void enableOrganization(long plOrgKey) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcAPIException
plOrgKey
- the organization keytcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
void enableOrganizations(long[] palOrgKeys) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
palOrgKeys
- the organization keys to be disbaledtcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
tcBulkException
void disableOrganization(long plOrgKey) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcAPIException
plOrgKey
- the organization keytcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
void disableOrganizations(long[] palOrgKeys) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
palOrgKeys
- the organization keys to be disabledtcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
tcBulkException
void deleteOrganization(long plOrgKey) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcAPIException
plOrgKey
- the organization to deletetcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
void deleteOrganizations(long[] palOrgKeys) throws tcInvalidOperationException, tcOrganizationNotFoundException, tcAPIException, tcBulkException, tcAPIException
palOrgKeys
- the organization keys to deletetcInvalidOperationException
tcOrganizationNotFoundException
tcAPIException
tcBulkException
long getNumberOfUsers(long plOrgKey) throws tcOrganizationNotFoundException, tcAPIException, tcAPIException
plOrgKey
- the organization keytcOrganizationNotFoundException
tcAPIException
long getNumberOfSubOrgs(long plOrgKey) throws tcOrganizationNotFoundException, tcAPIException, tcAPIException
plOrgKey
- the organizationtcOrganizationNotFoundException
tcAPIException
void removeObjectAllowed(long plOrgKey, long plObjectKey) throws tcAPIException, tcOrganizationNotFoundException, tcObjectNotFoundException, tcAPIException
plOrgKey
- The Organization KeyplObjectKey
- The object to be removed form allowed listtcAPIException
tcOrganizationNotFoundException
tcObjectNotFoundException
void updateObjectAllowed(long plOrgKey, long plObjectKey, java.util.Map phAttributeList) throws tcAPIException, tcOrganizationNotFoundException, tcObjectNotFoundException, tcInvalidAttributeException, tcAPIException
plOrgKey
- the organization keyplObjectKey
- the object keyphAttributeList
- Map containing the serviceable flag for the object allowedtcAPIException
tcOrganizationNotFoundException
tcObjectNotFoundException
tcInvalidAttributeException
Thor.API.tcResultSet getObjectsAllowed(long orgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
orgKey
- the organization keytcAPIException
tcOrganizationNotFoundException
void removeAdministrator(long plOrgKey, long plGroupKey) throws tcAPIException, tcOrganizationNotFoundException, tcGroupNotFoundException, tcAPIException
plOrgKey
- the organization keyplGroupKey
- the group key of the administrator to removetcAPIException
tcOrganizationNotFoundException
tcGroupNotFoundException
void updateAdministrator(long plOrgKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcOrganizationNotFoundException, tcGroupNotFoundException, tcAPIException, tcAPIException
plOrgKey
- The Key of the organizationplGroupKey
- String holding the Group KeypbWrite
- Whether the group has Write permissionspbDelete
- Whether the group has Delete permissionstcOrganizationNotFoundException
tcGroupNotFoundException
tcAPIException
void moveUsers(long[] palUserKeys, long plTargetOrgKey) throws tcAPIException, tcUserNotFoundException, tcOrganizationNotFoundException, tcBulkException, tcAPIException
palUserKeys
- the user keysplTargetOrgKey
- the target organization keytcAPIException
- thrown if an error occurs while getting the users or organization informationtcUserNotFoundException
- thrown if one or many of the users do not exist in the databsetcOrganizationNotFoundException
- thrown if the specified organization does not exist in the databsetcBulkException
- thrown if an error occurs during the bulk move operationvoid moveOrganizations(long[] palOrgKeys, long plTargetOrgKey) throws tcAPIException, tcOrganizationNotFoundException, tcBulkException, tcAPIException
palOrgKeys
- the sub-oragnization keysplTargetOrgKey
- the target organization keytcAPIException
- thrown if an error occurs while getting organization informationtcOrganizationNotFoundException
- thrown if the specified organizations do not exist in the databsetcBulkException
- thrown if an error occurs during the bulk move operationThor.API.tcResultSet getUnassignedAdministrators(long plOrgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The organization key return a tcResultSet of the unassigned administrators. The result set contains column names:tcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcOrganizationNotFoundException
- If the specified orgnization does not exist in the databseThor.API.tcResultSet getUnassignedResources(long plOrgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The Organization keytcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getUnassignedSubOrganizations(long plOrgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The Organization keytcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getUnassignedUsers(long plOrgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The Organization keytcAPIException
tcOrganizationNotFoundException
Thor.API.tcResultSet getObjects(long orgKey) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
orgKey
- Value holding the Organization KeytcResultSet
, each row holding information about an object that has been provisioned for the organization.tcAPIException
tcOrganizationNotFoundException
long provisionObject(long plOrgKey, long plObjectKey, java.util.Map phMapping) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The key of the organization to which the resource to be provisioned.plObjectKey
- The key of the object to provision.phMapping
- The Map with attributes.tcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcOrganizationNotFoundException
long provisionObject(long plOrgKey, long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The key of the organization to which the resource to be provisioned.plObjectKey
- The key of the object to provision.tcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcOrganizationNotFoundException
com.thortech.xl.vo.ResourceData provisionResource(long plOrgKey, long plObjectKey) throws tcAPIException, tcObjectNotFoundException, tcProvisioningNotAllowedException, tcOrganizationNotFoundException, tcAPIException
plOrgKey
- The key of the organization to which the resource to be provisioned.plObjectKey
- The key of the object to provision.tcAPIException
tcObjectNotFoundException
tcProvisioningNotAllowedException
tcOrganizationNotFoundException
boolean canResourceBeProvisioned(long orgKey, long objectKey) throws tcAPIException, tcOrganizationNotFoundException, tcObjectNotFoundException, tcAPIException
orgKey
- The key of the organization to which the resource is to be provisioned.objectKey
- This is the resource object keytcResultSet
each row holding information about a group the user is not a member of.tcAPIException
tcUserNotFoundException
tcOrganizationNotFoundException
tcObjectNotFoundException
Thor.API.tcResultSet getEncodedValue(java.lang.String strDecodeVal, java.lang.String strFieldName) throws tcAPIException, tcAPIException
valDecodes.
- If a null or empty array is passed, this function will raise the tcAPIExceptiontcUserNotFoundException
tcAPIException
Thor.API.tcResultSet getAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Organizations.key=1tcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcOrganizationNotFoundException
- If the specified orgnization does not exist in the databseThor.API.tcResultSet getUnassignedAdministrators(java.util.Map searchCriteria) throws tcAPIException, tcOrganizationNotFoundException, tcAPIException
searchCriteria
- Map holding the search criteria with key in Metadata form for filtering Groups e.g. Key=Groups.Group Name & Value=G1, Organizations.key=1 Metadata Keys that can be passed are as follows: Organizations-Groups.Created By, Organizations-Groups.Delete Permission Organizations-Groups.Updated By, Organizations-Groups.Write Access Groups.Created By, Groups.E-mail, Groups.Group Name, Groups.Key, Groups.Updated BytcAPIException
- Thrown if an error occurrs while retrieving the data about unassigned groups from the databasetcOrganizationNotFoundException
- If the specified orgnization does not exist in the databse
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |