Thor.API.Operations
Interface tcQueueOperationsIntf

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.

Method Detail

findQueues

public Thor.API.tcResultSet findQueues(java.util.Map phAttributeList)
                                throws Thor.API.Exceptions.tcAPIException,
                                       tcAPIException

Returns a list of queues (in the form of a result set) that matches the provided attribute list.

Parameters:

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 (%).

Returns:

A tcResultSet in which each row holds details about the queues that were found

Throws:

tcAPIException - thrown if data set errors occur

getMembers

public Thor.API.tcResultSet getMembers(long plQueueKey)
                                throws Thor.API.Exceptions.tcAPIException,
                                       Thor.API.Exceptions.tcQueueNotFoundException,
                                       tcAPIException

Returns a list of the members of a queue (in the form of a result set), alongwith the permissions they have specified.

Parameters:

plQueueKey - The Key of the queue whose members are to be retrieved

Returns:

A tcResultSet in which each row holds details about the queue members

Throws:

tcAPIException - thrown if data set errors occur

tcQueueNotFoundException - thrown if plQueueKey does not exist

getChildQueues

public Thor.API.tcResultSet getChildQueues(long plQueueKey)
                                    throws Thor.API.Exceptions.tcAPIException,
                                           Thor.API.Exceptions.tcQueueNotFoundException,
                                           tcAPIException

Returns a list of queues (in the form of a resultset) that are children of the specified queue

Parameters:

plQueueKey - The Key of the queue whose child queues are to be retrieved

Returns:

A tcResultSet in which each row holds details about the child queues

Throws:

tcAPIException - thrown if data set errors occur

tcQueueNotFoundException - thrown if plQueueKey does not exist

getAdministrators

public Thor.API.tcResultSet getAdministrators(long plQueueKey)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.tcQueueNotFoundException,
                                              tcAPIException

Returns a list of groups that are administrative groups of the specified queue. These are not the groups constituting the members of the queue, rather the groups that have administrative access to modify and update the queue.

Parameters:

plQueueKey - The Key of the queue whose administrative groups are to be retrieved

Returns:

A tcResultSet in which each row holds details (like group name, group key) about the administrative groups.

Throws:

tcAPIException - thrown if data set errors occur

tcQueueNotFoundException - thrown if plQueueKey does not exist

getQueuesForGroup

public Thor.API.tcResultSet getQueuesForGroup(long plGroupKey,
                                              java.lang.String psWrite,
                                              java.lang.String psDelete)
                                       throws Thor.API.Exceptions.tcAPIException,
                                              Thor.API.Exceptions.tcGroupNotFoundException,
                                              Thor.API.Exceptions.tcInvalidPermissionsException,
                                              tcAPIException

Returns a list of queues (in the form of a resultset) that have group(plGroupKey) as a member with permissions psWrite and psDelete

Parameters:

plGroupKey - The Key of the group that is a member of of the queue

psWrite - 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.

Returns:

A tcResultSet in which each row holds details about the queues that have the specified group as a member with the specified permissions. The result set consists of the queue key and queue name

Throws:

tcAPIException - thrown if data set errors occur

tcGroupNotFoundException - thrown if plGroupKey does not exist

tcInvalidPermissionsException - thrown if psPermissions are invalid

getQueuesForMemberUser

public Thor.API.tcResultSet getQueuesForMemberUser(long plUserKey,
                                                   java.lang.String psWrite,
                                                   java.lang.String psDelete)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   Thor.API.Exceptions.tcUserNotFoundException,
                                                   Thor.API.Exceptions.tcInvalidPermissionsException,
                                                   tcAPIException

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.

Parameters:

plUserKey - The Key of the member group user

psWrite - 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.

Returns:

A tcResultSet in which each row holds details about the queues that have member groups with permission psPermissions where the member groups have user plUserKey. The result set consists of the queue key, queue name, parent queue key, parent queue name, and the write/delete permissions the user has to the queue

Throws:

tcAPIException - thrown if data set errors occur

tcUserNotFoundException - thrown if plUserKey does not exist

tcInvalidPermissionsException - thrown if psPermissions are invalid

getMemberUsersForQueue

public Thor.API.tcResultSet getMemberUsersForQueue(long plQueueKey)
                                            throws Thor.API.Exceptions.tcAPIException,
                                                   Thor.API.Exceptions.tcQueueNotFoundException,
                                                   tcAPIException

Gets the Member Users for a Queue by direct or indirect inclusion.

Parameters:

plQueueKey - The queue key

Returns:

A tcResultSet in which each row holds details about the users that are directly or indirectly members of the queue member groups

Throws:

tcAPIException - thrown if data set errors occur

tcQueueNotFoundException - thrown if queue does not exist

createQueue

public long createQueue(java.lang.String psQueueName,
                        java.lang.String psQueueDescription,
                        long plParentQueueKey)
                 throws Thor.API.Exceptions.tcAPIException,
                        Thor.API.Exceptions.tcInvalidParentException,
                        Thor.API.Exceptions.tcDuplicateQueueException,
                        tcAPIException

Create a queue with the specified attributes.

Parameters:

psQueueName - The name of the queue

psQueueDescription - The description for the queue

plParentQueueKey - The key of the queue to be set as the parent. Provide 0 if no parent.

Returns:

The Key of the queue created

Throws:

tcAPIException - thrown if data set errors occur

tcInvalidParentException - thrown if plParentQueueKey does not exist

tcDuplicateQueueException - thrown if specified queue name is already in use

editQueue

public void editQueue(long plQueueKey,
                      java.util.Map phAttributeList)
               throws Thor.API.Exceptions.tcAPIException,
                      Thor.API.Exceptions.tcInvalidAttributeException,
                      tcAPIException

Edit a queue with the specified attributes.

Parameters:

plQueueKey - The key of the queue

phAttributeList - 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 parent

Throws:

tcAPIException - thrown if data set errors occur OR invalid plQueueKey is passed

tcInvalidAttributeException - thrown if Queue Key is provided as an attribute

addMember

public void addMember(long plQueueKey,
                      long plGroupKey,
                      boolean pbWrite,
                      boolean pbDelete)
               throws Thor.API.Exceptions.tcAPIException,
                      Thor.API.Exceptions.tcExistingMemberException,
                      tcAPIException

Adds the specified group as a Queue Member with the specified permissions.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the group to add as a member

pbWrite - Boolean indicating if the member will have write permission

pbDelete - Boolean indicating if the member will have delete permission

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey or plGroupKey is not valid

tcExistingMemberException - thrown if Member group already exists part of the Queue

updateMember

public void updateMember(long plQueueKey,
                         long plGroupKey,
                         boolean pbWrite,
                         boolean pbDelete)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcNotExistingMemberException,
                         tcAPIException

Updates the specified Queue Member group to have the specified permissions.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the group member to update

pbWrite - Boolean indicating if the member will have write permission

pbDelete - Boolean indicating if the member will have delete permission

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey is invalid

tcNotExistingMemberException - thrown if member group specified is not part of the queue

deleteMember

public void deleteMember(long plQueueKey,
                         long plGroupKey)
                  throws Thor.API.Exceptions.tcAPIException,
                         Thor.API.Exceptions.tcNotExistingMemberException,
                         tcAPIException

Delete the specified Queue Member group.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the group member to update

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey is invalid

tcNotExistingMemberException - thrown if the member is not in the Queue to begin with

addAdministrator

public void addAdministrator(long plQueueKey,
                             long plGroupKey,
                             boolean pbWrite,
                             boolean pbDelete)
                      throws Thor.API.Exceptions.tcAPIException,
                             Thor.API.Exceptions.tcExistingAdministratorException,
                             tcAPIException

Adds the specified group as a Queue Administrator with the specified permissions.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the group to add as an administrator

pbWrite - Boolean indicating if the administrator will have write permission

pbDelete - Boolean indicating if the administrator will have delete permission

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey/plGroupKey in invalid

tcExistingAdministratorException - thrown if the administrator group is already added

updateAdministrator

public void updateAdministrator(long plQueueKey,
                                long plGroupKey,
                                boolean pbWrite,
                                boolean pbDelete)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcNotExistingAdministratorException,
                                tcAPIException

Updates the specified Queue Administrator group to have the specified permissions.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the queue administrator to update

pbWrite - Boolean indicating if the administrator will have write permission

pbDelete - Boolean indicating if the administrator will have delete permission

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey is invalid

tcNotExistingAdministratorException - thrown if Administrator does not associate with the queue

deleteAdministrator

public void deleteAdministrator(long plQueueKey,
                                long plGroupKey)
                         throws Thor.API.Exceptions.tcAPIException,
                                Thor.API.Exceptions.tcNotExistingAdministratorException,
                                tcAPIException

Delete the specified Queue Administrator group.

Parameters:

plQueueKey - The Key of the queue

plGroupKey - The key of the group member to update

Throws:

tcAPIException - thrown if data set errors occur OR plQueueKey is invalid

tcNotExistingAdministratorException - Administrator is not associated with the Queue to begin with

getRootQueues

public Thor.API.tcResultSet getRootQueues(java.util.Map phAttributeList)
                                   throws Thor.API.Exceptions.tcAPIException,
                                          tcAPIException

Returns a list of root queues (in the form of a result set) that match the provided attribute list.

Parameters:

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 (%).

Returns:

A tcResultSet containing details about the root queues.

Throws:

tcAPIException - thrown if data set errors occur