org.osid.tracking

Interface MyIssueSession

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, OsidSession

public interface MyIssueSession
extends OsidSession

This session defines methods for retrieving issues.

This lookup session defines several views:

• comparative view: elements may be silently omitted or re-ordered
• plenary view: provides a complete result set or is an error condition

Issues may have an additional records indicated by their respective record types. The record may not be accessed through a cast of the Issues.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	canLookupMyIssues() 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.
IssueList	getMyClosedIssues() Gets closed issues where the agent is the customer.
IssueList	getMyIssues() Gets all issues for the agent.
IssueList	getMyIssuesInProgress() Gets the list of open issues in progress .
IssueList	getMyOpenIssues() Gets open issues where the agent is the customer.
IssueList	getMyOpenIssuesSinceDate(DateTime date) Gets a list of issues opened since given date.
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	usePlenaryIssueView() A complete view of the Issue returns is desired.

Methods inherited from interface org.osid.OsidSession

getAuthenticatedAgent, getAuthenticatedAgentId, getClockRate, getDate, getEffectiveAgent, getEffectiveAgentId, getFormatType, getLocale, isAuthenticated, startTransaction, supportsTransactions

Methods inherited from interface org.osid.binding.java.OsidSession

close

Methods inherited from interface java.io.Closeable

close

Method Detail

getFrontOfficeId

Id getFrontOfficeId()

Gets the FrontOffice Id associated with this session.

Returns:

the FrontOffice Id associated with this session

Compliance:

mandatory - This method must be implemented.

getFrontOffice

FrontOffice getFrontOffice()
                           throws OperationFailedException,
                                  PermissionDeniedException

Gets the FrontOffice associated with this session.

Returns:

the front office

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

canLookupMyIssues

boolean canLookupMyIssues()

Tests if this user can perform 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.

Returns:

false if lookup methods are not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeIssueView

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. This view is used when greater interoperability is desired at the expense of precision.

Compliance:

mandatory - This method is must be implemented.

usePlenaryIssueView

void usePlenaryIssueView()

A complete view of the 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.

Compliance:

mandatory - This method is must be implemented.

getMyOpenIssues

IssueList getMyOpenIssues()
                          throws OperationFailedException,
                                 PermissionDeniedException

Gets open issues where the agent is the customer. In plenary mode, the returned list contains all of the issues, 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.

Returns:

the returned IssueList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyIssuesInProgress

IssueList getMyIssuesInProgress()
                                throws OperationFailedException,
                                       PermissionDeniedException

Gets the list of open issues in progress . 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.

Returns:

the returned Issue list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyClosedIssues

IssueList getMyClosedIssues()
                            throws OperationFailedException,
                                   PermissionDeniedException

Gets closed issues where the agent is the customer. In plenary mode, the returned list contains all of the issues, 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.

Returns:

the returned IssueList

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyOpenIssuesSinceDate

IssueList getMyOpenIssuesSinceDate(DateTime date)
                                   throws OperationFailedException,
                                          PermissionDeniedException

Gets a list of issues opened since given date. 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.

Parameters:

date - a date

Returns:

the returned Issue list

Throws:

NullArgumentException - date is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getMyIssues

IssueList getMyIssues()
                      throws OperationFailedException,
                             PermissionDeniedException

Gets all issues for the agent. 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 and may present the elements in any order including returning a unique set.

Returns:

the returned Issue list

Throws:

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.