TSDRequest Class Reference
[XML Service Objects]

Parameter object for TSDService requests. More...

Inheritance diagram for TSDRequest:

[legend]

List of all members.

Public Member Functions
	addResourceId ($rId)
	Adds one or more resource IDs to the list in the 'resourceIds' parameter.
	enableType ($type, $enable)
	Enables or disables one of the three types for the 'types' parameter.
	getLimit ()
	INSERT BRIEF DESCRIPTION HERE.
	getMode ()
	Retrieves the 'mode' parameter.
	getObjectId ()
	Retrieves the 'objectId' parameter.
	getObjectType ()
	INSERT BRIEF DESCRIPTION HERE.
	getOffset ()
	INSERT BRIEF DESCRIPTION HERE.
	getOperation ()
	INSERT BRIEF DESCRIPTION HERE.
	getResourceIds ()
	Retrieves the 'resourceIds' parameter.
	getTypes ()
	Retrieves the 'types' parameter.
	setLimit ($limit)
	INSERT BRIEF DESCRIPTION HERE.
	setMode ($newMode)
	Sets 'mode' parameter.
	setObjectId ($id)
	Sets the 'objectId' parameter.
	setObjectType ($type)
	INSERT BRIEF DESCRIPTION HERE.
	setOffset ($offset)
	INSERT BRIEF DESCRIPTION HERE.
	setOperation ($op)
	INSERT BRIEF DESCRIPTION HERE.
	setResourceId ($rId)
	Sets the 'resourceIds' parameter.

---

Detailed Description

Parameter object for TSDService requests.

Pass an instance of this object to certain TSDService methods to provide parameters to those methods. The following parameters are supported:

• mode: one of the TSD::MODE_* constants, indicating which types of relations/alignments should be retrieved (approved, pending, etc.)
• types: which of standards, textbooks and dictionary words (or combination thereof) should be consulted when, e.g., getting a list of alignments for a given resource
• resourceIds: which CSERD resources to grab alignment/relationship info for
• objectId: not used right now

Definition at line 20 of file TSDRequest.php5.

---

Member Function Documentation

TSDRequest::addResourceId

(

$

rId

)

Adds one or more resource IDs to the list in the 'resourceIds' parameter.

Parameters:

$rId

[mixed]: scalar resource ID to add to request, or an array of them

Returns:

[boolean]: success or failure

Definition at line 110 of file TSDRequest.php5.

References SObject::setError().

TSDRequest::enableType	(	$	type,
		$	enable
	)

Enables or disables one of the three types for the 'types' parameter.

The three types can be turned on or off with a boolean flag passed to this method. By default, all three types are enabled, so you usually only need to selectively disable types that are not desired.

Parameters:

	$type	[string]: one of the TYPE_* constants
	$enable	[boolean]: whether to enable or disable the type

Returns:

[boolean]: success or failure

Definition at line 68 of file TSDRequest.php5.

References SObject::setError().

TSDRequest::getLimit

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 250 of file TSDRequest.php5.

TSDRequest::getMode

(

)

Retrieves the 'mode' parameter.

Returns:

[int]: value of 'mode' parameter

Definition at line 192 of file TSDRequest.php5.

TSDRequest::getObjectId

(

)

Retrieves the 'objectId' parameter.

Returns:

[mixed]: value of the 'objectId' parameter

Definition at line 217 of file TSDRequest.php5.

TSDRequest::getObjectType

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 228 of file TSDRequest.php5.

TSDRequest::getOffset

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 261 of file TSDRequest.php5.

TSDRequest::getOperation

(

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 239 of file TSDRequest.php5.

TSDRequest::getResourceIds

(

)

Retrieves the 'resourceIds' parameter.

Returns:

[array]: list of resource IDs

Definition at line 209 of file TSDRequest.php5.

TSDRequest::getTypes

(

)

Retrieves the 'types' parameter.

Returns:

[array]: value of the 'types' parameter (associative array with keys being the type names and the values being booleans indicating whether the type is enabled or not)

Definition at line 201 of file TSDRequest.php5.

TSDRequest::setLimit

(

$

limit

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$limit

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 172 of file TSDRequest.php5.

TSDRequest::setMode

(

$

newMode

)

Sets 'mode' parameter.

Parameters:

$newMode

[int]: one of the MODE_* constants

Returns:

[boolean]: success or failure

Definition at line 48 of file TSDRequest.php5.

References SObject::setError().

TSDRequest::setObjectId

(

$

id

)

Sets the 'objectId' parameter.

Parameters:

$id

[mixed]: new value for 'objectId' parameter

Returns:

[boolean]: success or failure

Definition at line 131 of file TSDRequest.php5.

References SObject::setError().

TSDRequest::setObjectType

(

$

type

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$type

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 148 of file TSDRequest.php5.

TSDRequest::setOffset

(

$

offset

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$offset

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 184 of file TSDRequest.php5.

TSDRequest::setOperation

(

$

op

)

INSERT BRIEF DESCRIPTION HERE.

INSERT FULL DESCRIPTION HERE

Parameters:

$op

[TYPE]: DESCRIPTION

Returns:

[TYPE]: RETURN DESCRIPTION

Definition at line 160 of file TSDRequest.php5.

TSDRequest::setResourceId

(

$

rId

)

Sets the 'resourceIds' parameter.

You can either provide a single resource ID as an integer/string, or provide an array of IDs. Any IDs already in the request will be overwritten.

Parameters:

$rId

[mixed]: array of resource IDs or a single resource ID as a scalar

Returns:

[boolean]: success or failure

Definition at line 86 of file TSDRequest.php5.

References SObject::setError().

---

The documentation for this class was generated from the following file:

• tsd/TSDRequest.php5