|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface tcQueueOperationsIntf
Method Summary | |
---|---|
void |
addAdministrator(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds the specified group as a Queue Administrator with the specified permissions. |
void |
addMember(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Adds the specified group as a Queue Member with the specified permissions. |
long |
createQueue(java.lang.String psQueueName, java.lang.String psQueueDescription, long plParentQueueKey) Create a queue with the specified attributes. |
void |
deleteAdministrator(long plQueueKey, long plGroupKey) Delete the specified Queue Administrator group. |
void |
deleteMember(long plQueueKey, long plGroupKey) Delete the specified Queue Member group. |
void |
editQueue(long plQueueKey, java.util.Map phAttributeList) Edit a queue with the specified attributes. |
Thor.API.tcResultSet |
findQueues(java.util.Map phAttributeList) Returns a list of queues (in the form of a result set) that matches the provided attribute list. |
Thor.API.tcResultSet |
getAdministrators(long plQueueKey) Returns a list of groups that are administrative groups of the specified queue. |
Thor.API.tcResultSet |
getChildQueues(long plQueueKey) Returns a list of queues (in the form of a resultset) that are children of the specified queue |
Thor.API.tcResultSet |
getMembers(long plQueueKey) Returns a list of the members of a queue (in the form of a result set), alongwith the permissions they have specified. |
Thor.API.tcResultSet |
getMemberUsersForQueue(long plQueueKey) Gets the Member Users for a Queue by direct or indirect inclusion. |
Thor.API.tcResultSet |
getQueuesForGroup(long plGroupKey, java.lang.String psWrite, java.lang.String psDelete) Returns a list of queues (in the form of a resultset) that have group(plGroupKey) as a member with permissions psWrite and psDelete |
Thor.API.tcResultSet |
getQueuesForMemberUser(long plUserKey, java.lang.String psWrite, java.lang.String psDelete) Returns a list of queues (in the form of a resultset) that have member groups with permissions psWrite and psDelete where the member groups have user plUserKey. |
Thor.API.tcResultSet |
getRootQueues(java.util.Map phAttributeList) Returns a list of root queues (in the form of a result set) that match the provided attribute list. |
void |
updateAdministrator(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Updates the specified Queue Administrator group to have the specified permissions. |
void |
updateMember(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) Updates the specified Queue Member group to have the specified permissions. |
Methods inherited from interface Thor.API.Base.tcUtilityOperationsIntf |
---|
close, getName, setCountry, setLanguage, setVariant |
Method Detail |
---|
Thor.API.tcResultSet findQueues(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to match the queue 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 (%).tcAPIException
- thrown if data set errors occurThor.API.tcResultSet getMembers(long plQueueKey) throws tcAPIException, tcQueueNotFoundException, tcAPIException
plQueueKey
- The Key of the queue whose members are to be retrievedtcAPIException
- thrown if data set errors occurtcQueueNotFoundException
- thrown if plQueueKey does not existThor.API.tcResultSet getChildQueues(long plQueueKey) throws tcAPIException, tcQueueNotFoundException, tcAPIException
plQueueKey
- The Key of the queue whose child queues are to be retrievedtcAPIException
- thrown if data set errors occurtcQueueNotFoundException
- thrown if plQueueKey does not existThor.API.tcResultSet getAdministrators(long plQueueKey) throws tcAPIException, tcQueueNotFoundException, tcAPIException
plQueueKey
- The Key of the queue whose administrative groups are to be retrievedtcAPIException
- thrown if data set errors occurtcQueueNotFoundException
- thrown if plQueueKey does not existThor.API.tcResultSet getQueuesForGroup(long plGroupKey, java.lang.String psWrite, java.lang.String psDelete) throws tcAPIException, tcGroupNotFoundException, tcInvalidPermissionsException, tcAPIException
plGroupKey
- The Key of the group that is a member of of the queuepsWrite
- The write permissions of the member group. The following parameter values are valid: "Y", "N", and empty string; where "Y" implies the group has write permissions, "N" implies the group does not have write permissions, and an empty string implies the group may or may not have write permissions. The values are case insensitive.psDelete
- The delete permissions of the member group. The following parameter values are valid: "Y", "N", and empty string; where "Y" implies the group has delete permissions, "N" implies the group does not have delete permissions, and an empty string implies the group may or may not have delete permissions. The values are case insensitive.tcAPIException
- thrown if data set errors occurtcGroupNotFoundException
- thrown if plGroupKey does not existtcInvalidPermissionsException
- thrown if psPermissions are invalidThor.API.tcResultSet getQueuesForMemberUser(long plUserKey, java.lang.String psWrite, java.lang.String psDelete) throws tcAPIException, tcUserNotFoundException, tcInvalidPermissionsException, tcAPIException
plUserKey
- The Key of the member group userpsWrite
- The write permissions of the member group. The following parameter values are valid: "Y", "N", and empty string; where "Y" implies the group has write permissions, "N" implies the group does not have write permissions, and an empty string implies the group may or may not have write permissions. The values are case insensitive.psDelete
- The delete permissions of the member group. The following parameter values are valid: "Y", "N", and empty string; where "Y" implies the group has delete permissions, "N" implies the group does not have delete permissions, and an empty string implies the group may or may not have delete permissions. The values are case insensitive.tcAPIException
- thrown if data set errors occurtcUserNotFoundException
- thrown if plUserKey does not existtcInvalidPermissionsException
- thrown if psPermissions are invalidThor.API.tcResultSet getMemberUsersForQueue(long plQueueKey) throws tcAPIException, tcQueueNotFoundException, tcAPIException
plQueueKey
- The queue keytcAPIException
- thrown if data set errors occurtcQueueNotFoundException
- thrown if queue does not existlong createQueue(java.lang.String psQueueName, java.lang.String psQueueDescription, long plParentQueueKey) throws tcAPIException, tcInvalidParentException, tcDuplicateQueueException, tcAPIException
psQueueName
- The name of the queuepsQueueDescription
- The description for the queueplParentQueueKey
- The key of the queue to be set as the parent. Provide 0 if no parent.tcAPIException
- thrown if data set errors occurtcInvalidParentException
- thrown if plParentQueueKey does not existtcDuplicateQueueException
- thrown if specified queue name is already in usevoid editQueue(long plQueueKey, java.util.Map phAttributeList) throws tcAPIException, tcInvalidAttributeException, tcAPIException
plQueueKey
- The key of the queuephAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to set for the queues. The Attribute names are the String column codes (from the Xellerate metadata). The Attribute Values are the String attributes to set for the queue. as the parenttcAPIException
- thrown if data set errors occur OR invalid plQueueKey is passedtcInvalidAttributeException
- thrown if Queue Key is provided as an attributevoid addMember(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcExistingMemberException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the group to add as a memberpbWrite
- Boolean indicating if the member will have write permissionpbDelete
- Boolean indicating if the member will have delete permissiontcAPIException
- thrown if data set errors occur OR plQueueKey or plGroupKey is not validtcExistingMemberException
- thrown if Member group already exists part of the Queuevoid updateMember(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcNotExistingMemberException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the group member to updatepbWrite
- Boolean indicating if the member will have write permissionpbDelete
- Boolean indicating if the member will have delete permissiontcAPIException
- thrown if data set errors occur OR plQueueKey is invalidtcNotExistingMemberException
- thrown if member group specified is not part of the queuevoid deleteMember(long plQueueKey, long plGroupKey) throws tcAPIException, tcNotExistingMemberException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the group member to updatetcAPIException
- thrown if data set errors occur OR plQueueKey is invalidtcNotExistingMemberException
- thrown if the member is not in the Queue to begin withvoid addAdministrator(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcExistingAdministratorException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the group to add as an administratorpbWrite
- Boolean indicating if the administrator will have write permissionpbDelete
- Boolean indicating if the administrator will have delete permissiontcAPIException
- thrown if data set errors occur OR plQueueKey/plGroupKey in invalidtcExistingAdministratorException
- thrown if the administrator group is already addedvoid updateAdministrator(long plQueueKey, long plGroupKey, boolean pbWrite, boolean pbDelete) throws tcAPIException, tcNotExistingAdministratorException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the queue administrator to updatepbWrite
- Boolean indicating if the administrator will have write permissionpbDelete
- Boolean indicating if the administrator will have delete permissiontcAPIException
- thrown if data set errors occur OR plQueueKey is invalidtcNotExistingAdministratorException
- thrown if Administrator does not associate with the queuevoid deleteAdministrator(long plQueueKey, long plGroupKey) throws tcAPIException, tcNotExistingAdministratorException, tcAPIException
plQueueKey
- The Key of the queueplGroupKey
- The key of the group member to updatetcAPIException
- thrown if data set errors occur OR plQueueKey is invalidtcNotExistingAdministratorException
- Administrator is not associated with the Queue to begin withThor.API.tcResultSet getRootQueues(java.util.Map phAttributeList) throws tcAPIException, tcAPIException
phAttributeList
- A map of name-value pairs, each entry holding an attribute-value pair to match the queue 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 (%).tcAPIException
- thrown if data set errors occur
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |