Interface RegistrationRequest

All Superinterfaces:

Browsable, Extensible, Identifiable, OsidObject, OsidRequest

public interface RegistrationRequest
extends OsidRequest

A RegistrationRequest.

Method Summary

Modifier and Type	Method	Description
RegistrationRequestRecord	getRegistrationRequestRecord(Type registrationRequestRecordType)	Gets the registration request record corresponding to the given RegistrationR equest record Type.
Term	getTerm()	Gets the term
Id	getTermId()	Gets the Id of the term.

Methods inherited from interface Browsable

getProperties, getPropertiesByRecordType

Modifier and Type	Method	Description
PropertyList	getProperties()	Gets a list of properties.
PropertyList	getPropertiesByRecordType(Type recordType)	Gets a list of properties corresponding to the specified record type.

Methods inherited from interface Extensible

getRecordTypes, hasRecordType

Modifier and Type	Method	Description
TypeList	getRecordTypes()	Gets the record types available in this object.
boolean	hasRecordType(Type recordType)	Tests if this object supports the given record Type.

Methods inherited from interface Identifiable

getId, isCurrent

Modifier and Type	Method	Description
Id	getId()	Gets the Id associated with this instance of this OSID object.
boolean	isCurrent()	Tests to see if the last method invoked retrieved up-to-date data.

Methods inherited from interface OsidObject

getDescription, getDisplayName, getGenusType, isOfGenusType

Modifier and Type	Method	Description
DisplayText	getDescription()	Gets the description associated with this instance of this OSID object.
DisplayText	getDisplayName()	Gets the preferred display name associated with this instance of this OSID object appropriate for display to the user.
Type	getGenusType()	Gets the genus type of this object.
boolean	isOfGenusType(Type genusType)	Tests if this object is of the given genus Type.

Methods inherited from interface OsidRequest

getCanceledDate, getError, getErrorId, getPostingDate, getProcessedDate, getRequester, getRequesterId, getSubmittedDate, getSubmitter, getSubmitterId, getSubmittingAgent, getSubmittingAgentId, hasError, isCanceled, isProcessed, isSubmitted

Modifier and Type	Method	Description
DateTime	getCanceledDate()	Gets the date the request was canceled.
State	getError()	Gets the error state.
Id	getErrorId()	Gets the Id of the error state.
DateTime	getPostingDate()	Gets the posting date of the request.
DateTime	getProcessedDate()	Gets the date the request processing completed.
Resource	getRequester()	Gets the requester.
Id	getRequesterId()	Gets the Id of the requester.
DateTime	getSubmittedDate()	Gets the date the request was submitted.
Resource	getSubmitter()	Gets the submittor.
Id	getSubmitterId()	Gets the Id of the submittor.
Agent	getSubmittingAgent()	Gets the submitting agent.
Id	getSubmittingAgentId()	Gets the Id of the submitting agent.
boolean	hasError()	Tests if this request has been processed but not fulfilled due to error.
boolean	isCanceled()	Tests if this request has been canceled.
boolean	isProcessed()	Tests if this request has been processed.
boolean	isSubmitted()	Tests if this request has been submitted.

Method Details

getTermId

Id getTermId()

Gets the Id of the term.

Returns:

the term Id

Compliance:

mandatory - This method must be implemented.

getTerm

Term getTerm()
      throws OperationFailedException

Gets the term

Returns:

the term

Throws:

OperationFailedException - unable to complete request

Compliance:

mandatory - This method must be implemented.

getRegistrationRequestRecord

RegistrationRequestRecord getRegistrationRequestRecord(Type registrationRequestRecordType)
                                                throws OperationFailedException

Gets the registration request record corresponding to the given RegistrationR equest record Type. This method ie used to retrieve an object implementing the requested record. The registrationRequestReco rdType may be the Type returned in getRecordTypes() or any of its parents in a Type hierarchy where hasRecordType(registrationRequestRecord Type) is true.

Parameters:

registrationRequestRecordType - the type of registration request record to retrieve

Returns:

the registration request record

Throws:

NullArgumentException - registrationRequestRecordType is null

OperationFailedException - unable to complete request

UnsupportedException - hasRecordType(registrationRequestRecordType) is false

Compliance:

mandatory - This method must be implemented.