blackboard.data
Interface Positionable

All Known Implementing Classes:

Content, ContentFileRef, ContentFolder, CourseDocument, CourseLink, CourseToc, ExternalLink, Lesson, StaffInfo, StaffInfoFolder

public interface Positionable

The Positionable interface specifies a set of methods for setting/determining the position of an object within a list of objects.

Since:

Bb 5.5

Version:

$Revision: #1 $ $Date: 2005/06/27 $

Field Summary

static int

POS_UNDEFINED

Method Summary

int	getPosition() Returns the position of this item within its current context.
void	setPosition(int nPos) Sets the position of this item within its current context.

Field Detail

POS_UNDEFINED

static final int POS_UNDEFINED

See Also:

Constant Field Values

Method Detail

getPosition

int getPosition()

Returns the position of this item within its current context. Position values are zero-based (the first element has a position value of zero).

Returns:

the position of this item within its current context. If this value has not been set or is unknown its value will be POS_UNDEFINED .

setPosition

void setPosition(int nPos)

Sets the position of this item within its current context. Position values are zero-based (the first element has a position value of zero).

Parameters:

nPos - the new position value of this item. This value should be a positive value.