|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueueManager
Defines methods for performing queue management functions in the workflow system. It also provides shared queue administration.
Field Summary | |
---|---|
static short |
QUEUE_TYPE_GROUP
Group queue type. |
static short |
QUEUE_TYPE_USER
User queue type. |
Method Summary | |
---|---|
long |
createUserQueue(UserQueue aNewQueueInfo)
Creates an additional queue for the current user. |
UserQueue |
getEmptyUserQueue()
Gets an instance of a new UserQueue object. |
GroupQueue |
getGroupQueue(java.lang.String aDomainName,
java.lang.String aGroupCanonicalName)
Creates a queue for a group. |
GroupQueue[] |
getGroupQueuesForUser()
Retrieves a list of the group queues for a particular user for queues with an active status. |
OOOProcessDesignate |
getNewOOOProcessDesignate()
Gets an instance of a new OOOProcessDesignate object. |
OutOfOfficeDateRange |
getNewOutOfOfficeDateRange()
Gets an instance of a new OutOfOfficeDateRange object. |
OutOfOfficeInfo |
getNewOutOfOfficeInfo()
Gets an instance of a new OutOfOfficeInfo object. |
OutOfOfficeInfo |
getOutOfOfficeSettings()
Retrieves the out of office settings for the current user |
OutOfOfficeInfo |
getOutOfOfficeSettings(UserDef specificUser)
Retrieves the current out of office settings for a specified user. |
UserQueue[] |
getUserQueues()
Retrieves a list of the user queues for a particular user for queues with an active status. |
UserSettings |
getUserSettings()
Deprecated. These settings are no longer used by the system. |
void |
grantQueueAccess(long aQueueId,
java.lang.String aUserIdToGrant)
Grants access to a queue for the current user. |
UserDef[] |
listSharedUsersForQueue(long queueId)
Retrieves a list of users who have access to an active queue. |
void |
removeUserQueue(long aQueueToRemove)
Removes the current user's queue. |
void |
revokeQueueAccess(long aQueueId,
java.lang.String aUserToRevoke)
Removes access to a queue for a specific user. |
void |
saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo)
Sets the Out of office settings for the current user. |
void |
saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo,
UserDef specificUser)
Sets the Out of office settings for a specific user. |
void |
setUserSettings(UserSettings aSettings)
Deprecated. These settings are no longer used by the system. |
Field Detail |
---|
static final short QUEUE_TYPE_USER
static final short QUEUE_TYPE_GROUP
Method Detail |
---|
void grantQueueAccess(long aQueueId, java.lang.String aUserIdToGrant) throws QueueManagerException
aQueueId
- The queue to share.aUserIdToGrant
- The user to which to grant access to this queue.
QueueManagerException
- if the queue to be shared is not a user queue, the queue is not found, or the queue is already shared.void revokeQueueAccess(long aQueueId, java.lang.String aUserToRevoke) throws QueueManagerException
aQueueId
- The queue from which to remove access.aUserToRevoke
- The user from which to remove access for this queue.
QueueManagerException
- if it is not a user queue, if the user does not already have access, or if the queue is owned by the user.UserQueue[] getUserQueues() throws QueueManagerException
UserQueue
objects.
QueueManagerException
GroupQueue[] getGroupQueuesForUser() throws QueueManagerException
UserQueue
objects.
QueueManagerException
long createUserQueue(UserQueue aNewQueueInfo) throws QueueManagerException
aNewQueueInfo
- Contains the queue information (including the title and description).
QueueManagerException
GroupQueue getGroupQueue(java.lang.String aDomainName, java.lang.String aGroupCanonicalName) throws QueueManagerException
GroupQueue
will be returned.
aDomainName
- The identifier for the domain in which the group resides.aGroupCanonicalName
- The canonical name for the group.
QueueManagerException
void removeUserQueue(long aQueueToRemove) throws QueueManagerException
aQueueToRemove
- The queue to remove.
QueueManagerException
- if attempting to remove a non-user queue, a user's default queue, or a queue not owned by the user.UserDef[] listSharedUsersForQueue(long queueId) throws QueueManagerException
queueId
- The queue for which to return a list of users.
QueueManagerException
- if the user identified does not own the queue, the queue is not found, or the queue is not active.UserQueue getEmptyUserQueue()
UserQueue
object.
After you populte the object with user queue settings, use it as an argument in
the createUserQueue()
method.
UserQueue
object.QueueManager#createUserQueue createUserQueue()]
UserSettings getUserSettings() throws QueueManagerException
QueueManagerException
void setUserSettings(UserSettings aSettings) throws QueueManagerException
aSettings
- The new settings for the current user.
QueueManagerException
OutOfOfficeInfo getOutOfOfficeSettings() throws QueueManagerException
QueueManagerException
OutOfOfficeInfo getOutOfOfficeSettings(UserDef specificUser) throws QueueManagerException
specificUser
- A UserDef
object populated with the User's ID
QueueManagerException
void saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo) throws QueueManagerException
oooInfo
- A populated OutOfOfficeInfo object
QueueManagerException
void saveOutOfOfficeSettings(OutOfOfficeInfo oooInfo, UserDef specificUser) throws QueueManagerException
oooInfo
- A OutOfOfficeInfo object populated with the Out of office settings.specificUser
- A UserDef object populated with the User's ID.
QueueManagerException
OutOfOfficeInfo getNewOutOfOfficeInfo()
OutOfOfficeInfo
object.
After you populate the object with Out of Office settings,
use it as an argument in the saveOutOfOfficeSettings()
or
saveOutOfOfficeSettings()
methods.
OutOfOfficeDateRange getNewOutOfOfficeDateRange()
OutOfOfficeDateRange
object.
After you populate the object with Out of Office date ranges,
use it as an argument in the setDateRanges()
method.
OOOProcessDesignate getNewOOOProcessDesignate()
OOOProcessDesignate
object.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |