Interface StepConstrainerOfficeSession

All Superinterfaces:

AutoCloseable, Closeable, OsidSession, OsidSession

public interface StepConstrainerOfficeSession
extends OsidSession

This session provides methods to retrieve StepConstrainer to Office mappings. a StepConstrainer may appear in multiple Office objects. Each 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	canLookupStepConstrainerOfficeMappings()	Tests if this user can perform lookups of step constrainer/office mappings.
IdList	getOfficeIdsByStepConstrainer(Id stepConstrainerId)	Gets the Office Ids mapped to a StepConstrainer .
OfficeList	getOfficesByStepConstrainer(Id stepConstrainerId)	Gets the Offices mapped to a StepConstrainer .
IdList	getStepConstrainerIdsByOffice(Id officeId)	Gets the list of StepConstrainerIds associated with an Office .
IdList	getStepConstrainerIdsByOffices(IdList officeIds)	Gets the list of StepConstrainerIds corresponding to a list of Offices .
StepConstrainerList	getStepConstrainersByOffice(Id officeId)	Gets the list of step constrainer associated with an Office .
StepConstrainerList	getStepConstrainersByOffices(IdList officeIds)	Gets the list of step constrainer corresponding to a list of Offices .
void	useComparativeStepConstrainerOfficeView()	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	usePlenaryStepConstrainerOfficeView()	A complete view of the StepConstrainer 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

canLookupStepConstrainerOfficeMappings

boolean canLookupStepConstrainerOfficeMappings()

Tests if this user can perform lookups of step constrainer/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 . This 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.

useComparativeStepConstrainerOfficeView

void useComparativeStepConstrainerOfficeView()

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.

usePlenaryStepConstrainerOfficeView

void usePlenaryStepConstrainerOfficeView()

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

getStepConstrainerIdsByOffice

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

Gets the list of StepConstrainerIds associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related step constrainer 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.

getStepConstrainersByOffice

StepConstrainerList getStepConstrainersByOffice(Id officeId)
                                         throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the list of step constrainer associated with an Office .

Parameters:

officeId - Id of the Office

Returns:

list of related step constrainers

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.

getStepConstrainerIdsByOffices

IdList getStepConstrainerIdsByOffices(IdList officeIds)
                               throws OperationFailedException,
PermissionDeniedException

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

Parameters:

officeIds - list of office Ids

Returns:

list of step constrainer Ids

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getStepConstrainersByOffices

StepConstrainerList getStepConstrainersByOffices(IdList officeIds)
                                          throws OperationFailedException,
PermissionDeniedException

Gets the list of step constrainer corresponding to a list of Offices .

Parameters:

officeIds - list of office Ids

Returns:

list of step constrainers

Throws:

NullArgumentException - officeIds is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficeIdsByStepConstrainer

IdList getOfficeIdsByStepConstrainer(Id stepConstrainerId)
                              throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Office Ids mapped to a StepConstrainer .

Parameters:

stepConstrainerId - Id of a StepConstrainer

Returns:

list of offices

Throws:

NotFoundException - stepConstrainerId is not found

NullArgumentException - stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.

getOfficesByStepConstrainer

OfficeList getOfficesByStepConstrainer(Id stepConstrainerId)
                                throws NotFoundException,
OperationFailedException,
PermissionDeniedException

Gets the Offices mapped to a StepConstrainer .

Parameters:

stepConstrainerId - Id of a StepConstrainer

Returns:

list of offices

Throws:

NotFoundException - stepConstrainerId is not found

NullArgumentException - stepConstrainerId is null

OperationFailedException - unable to complete request

PermissionDeniedException - authorization failure

Compliance:

mandatory - This method must be implemented.