com.ibm.workplace.wcm.api
Interface LibraryNumericComponent

All Superinterfaces:

Document, EditableLibraryComponent, LibraryComponent

public interface LibraryNumericComponent

extends EditableLibraryComponent

Represents a Number component.

A LibraryNumericComponent is a LibraryComponent and must be stored as a separate entity in the repository.

The LibraryNumericComponent can contain Number. This interface provides methods to retrieve and set the Number contained within this component.

note: since v6.0.0, a LibraryComponent is referred to as a "Component" in the Authoring UI.

See Also:

LibraryComponent

Field Summary

static int	TYPE_DOUBLE Type constant indicating that the Number returned will be a double.
static int	TYPE_INTEGER Type constant indicating that the Number returned will be an integer.

Method Summary

java.lang.Number	getNumber() Returns the Number contained in this component as a Number.
int	getNumberType() Returns the number type of this NumberComponent.
void	setNumber(java.lang.Number number) Sets the Number contained in this NumericComponent.
void	setNumberType(int numberType) Sets the number type contained in this NumericComponent.

Methods inherited from interface com.ibm.workplace.wcm.api.EditableLibraryComponent

addAuthors, addDeleteAccessMembers, addEditAccessMembers, addLiveAccessMembers, addOwners, addReadAccessMembers, isChanged, removeAuthors, removeDeleteAccessMembers, removeEditAccessMembers, removeLiveAccessMembers, removeOwners, removeReadAccessMembers, setDescription, setName, setTitle

Methods inherited from interface com.ibm.workplace.wcm.api.Document

getAuthors, getDeleteAccessMembers, getDescription, getEditAccessMembers, getHistoryLog, getId, getLiveAccessMembers, getModifiedDate, getName, getOwnerLibrary, getOwners, getReadAccessMembers, getTitle, hasDeleteAccess, hasDeleteAccess, hasEditAccess, hasEditAccess, hasLiveAccess, hasLiveAccess, hasReadAccess, hasReadAccess

Field Detail

TYPE_INTEGER

public static final int TYPE_INTEGER

Type constant indicating that the Number returned will be an integer.

See Also:

Constant Field Values

TYPE_DOUBLE

public static final int TYPE_DOUBLE

Type constant indicating that the Number returned will be a double.

See Also:

Constant Field Values

Method Detail

getNumber

public java.lang.Number getNumber()

Returns the Number contained in this component as a Number.

Returns null if the Number is not set.

Returns:

the Number

setNumber

public void setNumber(java.lang.Number number)
               throws OperationFailedException

Sets the Number contained in this NumericComponent.

Note. This method replaces any existing Number in this component.

Parameters:

number - the Number

Throws:

OperationFailedException - if the Number argument is null or the Number could not be set

getNumberType

public int getNumberType()

Returns the number type of this NumberComponent.

Returns the default value LibraryNumericComponent.TYPE_INTEGER if the new number type has been set.

Returns:

the number type

setNumberType

public void setNumberType(int numberType)
                   throws OperationFailedException

Sets the number type contained in this NumericComponent.

Valid values are:

• TYPE_INTEGER - Number type integer
• TYPE_DOUBLE - Number type double

Parameters:

numberType - the number type to be set

Throws:

OperationFailedException - if an invalid type was specified