Interface StepEnablerOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepEnablerOfficeSession
extends OsidSession

This session provides methods to retrieve StepEnabler to Office mappings. A StepEnabler may appear in multiple Office objects. E ach office may have its own authorizations governing who is allowed to look at it.

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

Method Summary

Modifier and Type	Method	Description
boolean	canLookupStepEnablerOfficeMappings()	Tests if this user can perform lookups of step enabler/office mappings.
IdList	getOfficeIdsByStepEnabler(Id stepEnablerId)	Gets the Office Ids mapped to a StepEnabler .
OfficeList	getOfficesByStepEnabler(Id stepEnablerId)	Gets the Offices mapped to a StepEnabler .
IdList	getStepEnablerIdsByOffice(Id officeId)	Gets the list of StepEnabler Ids associated with an Office .
IdList	getStepEnablerIdsByOffices(IdList officeIds)	Gets the list of StepEnabler Ids corresponding to a list of Offices .
StepEnablerList	getStepEnablersByOffice(Id officeId)	Gets the list of StepEnablers associated with an Office .
StepEnablerList	getStepEnablersByOffices(IdList officeIds)	Gets the list of StepEnablers corresponding to a list of Offices .
void	useComparativeStepEnablerOfficeView()	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	usePlenaryStepEnablerOfficeView()	A complete view of the StepEnabler and Office returns is desired.

Methods inherited from interface Closeable

close

Methods inherited from interface OsidSession

close

Modifier and Type	Method	Description
void	close()	Close this session.

Methods inherited from interface OsidSession

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

Modifier and Type	Method	Description
Agent	getAuthenticatedAgent()	Gets the agent authenticated to this session.
Id	getAuthenticatedAgentId()	Gets the Id of the agent authenticated to this session.
BigDecimal	getClockRate()	Gets the rate of the service clock.
Date	getDate()	Gets the service date which may be the current date or the effective date in which this session exists.
Agent	getEffectiveAgent()	Gets the effective agent in use by this session.
Id	getEffectiveAgentId()	Gets the Id of the effective agent in use by this session.
Type	getFormatType()	Gets the DisplayText format Type preference in effect for this session.
Locale	getLocale()	Gets the locale indicating the localization preferences in effect for this session.
boolean	isAuthenticated()	Tests if an agent is authenticated to this session.
Transaction	startTransaction()	Starts a new transaction for this sesson.
boolean	supportsTransactions()	Tests for the availability of transactions.

Method Details

canLookupStepEnablerOfficeMappings

boolean canLookupStepEnablerOfficeMappings()

Tests if this user can perform lookups of step enabler/office mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known lookup methods in this session will result in a PERMISSION_DENIED. T his is intended as a hint to an application that may opt not to offer lookup operations to unauthorized users.

Returns:

false if looking up mappings is not authorized, true otherwise

Compliance:

mandatory - This method must be implemented.

useComparativeStepEnablerOfficeView

void useComparativeStepEnablerOfficeView()

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.

usePlenaryStepEnablerOfficeView

void usePlenaryStepEnablerOfficeView()

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

getStepEnablerIdsByOffice

IdList getStepEnablerIdsByOffice(Id officeId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of StepEnabler Ids associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related step enabler Ids

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepEnablersByOffice

StepEnablerList getStepEnablersByOffice(Id officeId)
                                 throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of StepEnablers associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related step enablers

Throws:

NotFoundException - officeId is not found

NullArgumentException - officeId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepEnablerIdsByOffices

IdList getStepEnablerIdsByOffices(IdList officeIds)
                           throws OperationFailedException,
PermissionDeniedException

Gets the list of StepEnabler Ids corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of step enabler Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepEnablersByOffices

StepEnablerList getStepEnablersByOffices(IdList officeIds)
                                  throws OperationFailedException,
PermissionDeniedException

Gets the list of StepEnablers corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of step enablers

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByStepEnabler

IdList getOfficeIdsByStepEnabler(Id stepEnablerId)
                          throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Office Ids mapped to a StepEnabler .

Parameters:

stepEnablerId - Id of a StepEnabler

Returns:

list of office Ids

Throws:

NotFoundException - stepEnablerId is not found

NullArgumentException - stepEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByStepEnabler

OfficeList getOfficesByStepEnabler(Id stepEnablerId)
                            throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Offices mapped to a StepEnabler .

Parameters:

stepEnablerId - Id of a StepEnabler

Returns:

list of offices

Throws:

NotFoundException - stepEnablerId is not found

NullArgumentException - stepEnablerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.