OSID Logo
OSID Specifications
lexicon package
Version 3.0.0
Interfaceosid.lexicon.ParameterPressAssignmentSession
Implementsosid.OsidSession
Used Byosid.lexicon.LexiconManager
osid.lexicon.LexiconProxyManager
Description

This session provides methods to re-assign Parameter to Press mappings. A Parameter may appear in multiple Press objects and removing the last reference to a Parameter is the equivalent of deleting it. Each Press may have its own authorizations governing who is allowed to operate on it.

Adding a reference of a Parameter to another Press is not a copy operation (eg: does not change its Id ).

MethodcanAssignParameters
Description

Tests if this user can alter parameter/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an press that may opt not to offer assignment operations to unauthorized users.

Returnbooleanfalse if mapping is not authorized, true otherwise
CompliancemandatoryThis method must be implemented.
MethodcanAssignParametersToPress
Description

Tests if this user can alter parameter/press mappings. A return of true does not guarantee successful authorization. A return of false indicates that it is known mapping methods in this session will result in a PERMISSION_DENIED . This is intended as a hint to an press that may opt not to offer assignment operations to unauthorized users.

Parametersosid.id.IdpressIdthe Id of the Press
Returnbooleanfalse if mapping is not authorized, true otherwise
ErrorsNULL_ARGUMENTpressId is null
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePressIds
Description

Gets a list of presses including and under the given press node in which any parameter can be assigned.

Parametersosid.id.IdpressIdthe Id of the Press
Returnosid.id.IdListlist of assignable press Ids
ErrorsNULL_ARGUMENTpressId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodgetAssignablePressIdsForParameter
Description

Gets a list of presses including and under the given press node in which a specific parameter can be assigned.

Parametersosid.id.IdpressIdthe Id of the Press
osid.id.IdparameterIdthe Id of the Parameter
Returnosid.id.IdListlist of assignable press Ids
ErrorsNULL_ARGUMENTpressId or parameterId is null
OPERATION_FAILEDunable to complete request
CompliancemandatoryThis method must be implemented.
MethodassignParameterToPress
Description

Adds an existing Parameter to a Press .

Parametersosid.id.IdparameterIdthe Id of the Parameter
osid.id.IdpressIdthe Id of the Press
ErrorsALREADY_EXISTSparameterId is already assigned to pressId
NOT_FOUNDparameterId or pressId not found
NULL_ARGUMENTparameterId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodunassignParameterFromPress
Description

Removes a Parameter from a Press .

Parametersosid.id.IdparameterIdthe Id of the Parameter
osid.id.IdpressIdthe Id of the Press
ErrorsNOT_FOUNDparameterId or pressId not found or parameterId not assigned to pressId
NULL_ARGUMENTparameterId or pressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.
MethodreassignParameterToPress
Description

Moves a Parameter from one Press to another. Mappings to other Presses are unaffected.

Parametersosid.id.IdparameterIdthe Id of the Parameter
osid.id.IdfromPressIdthe Id of the current Press
osid.id.IdtoPressIdthe Id of the destination Press
ErrorsNOT_FOUNDparameterId, fromPressId , or toPressId not found or parameterId not mapped to fromPressId
NULL_ARGUMENTparameterId, fromPressId , or toPressId is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
CompliancemandatoryThis method must be implemented.