public interface IssueLookupSession extends OsidSession
This session defines methods for retrieving issues.
This lookup session defines several views:
Issues
with the IssueAdminSession.
The methods useFederatedFrontOfficeView()
and
useIsolatedFrontOfficeView()
behave as a radio group and one
should be selected before invoking any lookup methods.
Issues may have an additional records indicated by their respective
record types. The record may not be accessed through a cast of the
Issues.
Modifier and Type | Method and Description |
---|---|
boolean |
canLookupIssues()
Tests if this user can perform
Issue lookups. |
FrontOffice |
getFrontOffice()
Gets the
FrontOffice associated with this session. |
Id |
getFrontOfficeId()
Gets the
FrontOffice Id associated with
this session. |
Issue |
getIssue(Id issueId)
Gets the
Issue specified by its Id. |
IssueList |
getIssues()
Gets all issues.
|
IssueList |
getIssuesByGenusType(Type issueGenusType)
Gets an
IssueList corresponding to the given issue
genus Type which does not include issues of types
derived from the specified Type. |
IssueList |
getIssuesByIds(IdList issueIds)
Gets an
IssueList corresponding to the given
IdList. |
IssueList |
getIssuesByParentGenusType(Type issueGenusType)
Gets an
IssueList corresponding to the given issue
genus Type and include any additional issues with genus
types derived from the specified Type. |
IssueList |
getIssuesByRecordType(Type issueRecordType)
Gets an
IssueList containing the given issue record
Type. |
IssueList |
getIssuesForCustomer(Id resourceId)
Gets a list of issues by customer.
|
IssueList |
getIssuesForCustomerOnDate(Id resourceId,
DateTime from,
DateTime to)
Gets a list of issues for a customer effective beginning in the date
range.
|
IssueList |
getIssuesForQueue(Id queueId)
Gets a list of issues by queue.
|
IssueList |
getIssuesForQueueAndCustomer(Id queueId,
Id resourceId)
Gets a list of issues by queue and customer.
|
IssueList |
getIssuesForQueueAndCustomerOnDate(Id queueId,
Id resourceId,
DateTime from,
DateTime to)
Gets a list of issues for a queue and customer effective beginning in
the date range.
|
IssueList |
getIssuesForQueueOnDate(Id queueId,
DateTime from,
DateTime to)
Gets a list of issues for a queue effective beginning in the date
range.
|
IssueList |
getIssuesOnDate(DateTime from,
DateTime to)
Gets a list of issues effective beginning in the date range.
|
void |
useAnyEffectiveIssueView()
All issues of any effective dates are returned by methods in this
session.
|
void |
useComparativeIssueView()
The returns from the lookup methods may omit or translate elements
based on this session, such as authorization, and not result in an
error.
|
void |
useEffectiveIssueView()
Only issues whose effective dates are current are returned by methods
in this session.
|
void |
useFederatedFrontOfficeView()
Federates the view for methods in this session.
|
void |
useIsolatedFrontOfficeView()
Isolates the view for methods in this session.
|
void |
usePlenaryIssueView()
A complete view of the
Issue returns is desired. |
getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions
close
Id getFrontOfficeId()
FrontOffice
Id
associated with
this session. FrontOffice Id
associated with this sessionmandatory
- This method must be implemented. FrontOffice getFrontOffice() throws OperationFailedException, PermissionDeniedException
FrontOffice
associated with this session.OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. boolean canLookupIssues()
Issue
lookups. A return
of true does not guarantee successful authorization. A return of false
indicates that it is known all methods in this session will result in
a PERMISSION_DENIED.
This is intended as a hint to an
application that may not offer lookup operations to unauthorized
users. false
if lookup methods are not authorized,
true
otherwisemandatory
- This method must be implemented. void useComparativeIssueView()
mandatory
- This method is must be implemented. void usePlenaryIssueView()
Issue
returns is desired.
Methods will return what is requested or result in an error. This view
is used when greater precision is desired at the expense of
interoperability.mandatory
- This method is must be implemented. void useFederatedFrontOfficeView()
mandatory
- This method is must be implemented. void useIsolatedFrontOfficeView()
mandatory
- This method is must be implemented. void useEffectiveIssueView()
mandatory
- This method is must be implemented. void useAnyEffectiveIssueView()
mandatory
- This method is must be implemented. Issue getIssue(Id issueId) throws NotFoundException, OperationFailedException, PermissionDeniedException
Issue
specified by its Id.
In plenary mode, the exact Id
is found
or a NOT_FOUND
results. Otherwise, the returned
Issue
may have a different Id
than requested,
such as the case where a duplicate Id
was assigned to
an Issue
and retained for compatibility.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.issueId
- the Id
of the Issue
to
retrieve Issue
NotFoundException
- no Issue
found with
the given Id
NullArgumentException
- issueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByIds(IdList issueIds) throws NotFoundException, OperationFailedException, PermissionDeniedException
IssueList
corresponding to the given
IdList.
In plenary mode, the returned list contains all of the
issues specified in the Id
list, in the order of the
list, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Issues
may be omitted from the list and
may present the elements in any order including returning a unique
set.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.issueIds
- the list of Ids
to retrieve Issue
listNotFoundException
- an Id was
not foundNullArgumentException
- issueIds
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByGenusType(Type issueGenusType) throws OperationFailedException, PermissionDeniedException
IssueList
corresponding to the given issue
genus Type
which does not include issues of types
derived from the specified Type.
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.issueGenusType
- an issue genus type Issue
listNullArgumentException
- issueGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByParentGenusType(Type issueGenusType) throws OperationFailedException, PermissionDeniedException
IssueList
corresponding to the given issue
genus Type
and include any additional issues with genus
types derived from the specified Type.
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.issueGenusType
- an issue genus type Issue
listNullArgumentException
- issueGenusType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesByRecordType(Type issueRecordType) throws OperationFailedException, PermissionDeniedException
IssueList
containing the given issue record
Type.
In plenary mode, the returned list contains all known issues or an
error results. Otherwise, the returned list may contain only those
issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.issueRecordType
- an issue record type Issue
listNullArgumentException
- issueRecordType
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesOnDate(DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
from
- start of date rangeto
- end of date range Issue
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- from
or
to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForQueue(Id queueId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.queueId
- a queue Id
Issue
listNullArgumentException
- queueId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForQueueOnDate(Id queueId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective issues and those currently expired are returned.queueId
- a queue Id
from
- start of date rangeto
- end of date range Issue
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- queueId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForCustomer(Id resourceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.resourceId
- a resource Id
Issue
listNullArgumentException
- resourceId
is
null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForCustomerOnDate(Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective issues and those currently expired are returned.resourceId
- a resource Id
from
- start of date rangeto
- end of date range Issue
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- resourceId, from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForQueueAndCustomer(Id queueId, Id resourceId) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned.queueId
- a queue Id
resourceId
- a resource Id
Issue
listNullArgumentException
- queueId
or
resourceId
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssuesForQueueAndCustomerOnDate(Id queueId, Id resourceId, DateTime from, DateTime to) throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all known
issues or an error results. Otherwise, the returned list may contain
only those issues that are accessible through this session.
In effective mode, issues are returned that are currently effective in
addition to being effective in the given date range. In any effective
mode, effective issues and those currently expired are returned.queueId
- a queue Id
resourceId
- a resource Id
from
- start of date rangeto
- end of date range Issue
listInvalidArgumentException
- from
is
greater than to
NullArgumentException
- queueId, resourceId,
from,
or to
is null
OperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented. IssueList getIssues() throws OperationFailedException, PermissionDeniedException
In plenary mode, the returned list contains all of the
issues, including duplicates, or an error results if an Id
in the supplied list is not found or inaccessible. Otherwise,
inaccessible Issues
may be omitted from the list.
In effective mode, issues are returned that are currently effective.
In any effective mode, effective issues and those currently expired
are returned. Issue
listOperationFailedException
- unable to complete requestPermissionDeniedException
- authorization failuremandatory
- This method must be implemented.