WebCenter JavaScript API

Interface Summary

API

This interface describes the JavaScript API.

Attribute

This interface describes an attribute value.

Project

This interface describes a project.


Task


This interface describes a task.



image


Interface API


image


This interface describes the JavaScript API.


Methods


getProject

public Project getProject()

Get the current project.

Returns:

The object representing the current project.


image


Interface Attribute


image


This interface describes an attribute value.


Methods

getName

public String getName()

Get the name of the attribute.


image


getValue

public String getValue()

Get the value of the attribute.

Returns:

The value of the attribute as String. These are the name(s) of the referenced document(s) for document reference attributes.


image


setValue

public void setValue(String newValue)

Set a new value for the attribute.

Parameters:

newValue - The new (String) value for the attribute.


image


Interface Project


image


This interface describes a project.


Methods

getAttribute

public Attribute getAttribute(String attributeName)

throws

IllegalArgumentException

Get the project attribute (value) with the given name.

Parameters:

attributeName - The name of the attribute.

Returns:

An attribute object for the attribute value of the attribute with the given name or null if the attribute does not exist for this project.

Throws:

IllegalArgumentException - If the provided attribute name is null.


image


getAttributeCategoryName

public String getAttributeCategoryName()

Get the name of the attribute category of this project.

Returns:

The name of the attribute category of this project or an empty String if there is no project attribute category.


image


getAttributes

public Attribute[] getAttributes()

Get an array of all attributes of the project

Returns:

An array with attribute objects representing the attributes of this project.


image


getChildProjects

public Project[] getChildProjects()

Get an array of all child projects.

Returns:

An array with project objects which are child projects of this project.


image

getDescription

public String getDescription()

Get the description of the project.

Returns:

The description of the project.


image


getDueDate

public long getDueDate()

Get the due date of the project.

Returns:

The due date of the project as a long representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.


image


getName

public String getName()

Get the name of the project.

Returns:

The name of the project.


image


getParentProjects

public Project[] getParentProjects()

Get an array of all parent projects.

Returns:

An array with project objects which are parent projects of this project.


image


getStatusName

public String getStatusName()

Get the project status name.

Returns:

The name of the project status.


image

getTasks

public Task[] getTasks()

Get an array of all the tasks of this project.

Returns:

An array with task objects representing the tasks of this project.


image


setDescription

public void setDescription(String newDescription) throws IllegalArgumentException

Set the description of the project.

Parameters:

newDescription - The new description of the project.

Throws:

IllegalArgumentException - If the provided project description is null


image


setDueDate

public void setDueDate(long newDueDate)

Set the new due date of the project.

Parameters:

newDueDate - The new due date for the project as a long representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.


image


setName

public void setName(String newName)

throws IllegalArgumentException

Set the name of the project.

Parameters:

newName - The new name of the project.

Throws:

IllegalArgumentException - If the provided project name is null


image

setStatusByName

public void setStatusByName(String newProjectStatusName) throws IllegalArgumentException

Set a new project status by name.

Parameters:

newProjectStatusName - The new project status name. This is case insensitive.

Throws:

IllegalArgumentException - If the provided project status name is null or if the status cannot be found in the system


image


Interface Task


image


This interface describes a task.


Methods


getDueDate

public long getDueDate()

Get the due date of the task.

Returns:

The due date of the task as a long representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.


image


getLeadTime

public long getLeadTime()

Get the lead time of the task.

Returns:

The lead time of the task in milliseconds.


image

getName

public String getName()

Get the name of the task.

Returns:

The name of this task.


image


getStatusName

public String getStatusName()

Get the name of the task status of the task.

Returns:

The name of the task status of the task.


image


getTaskTypeName

public String getTaskTypeName()

Get the name of the task type.

Returns:

The name of the task type of this task.


image


setDueDate

public void setDueDate(long newDueDate)

Set the new due date of the task.

Parameters:

newDueDate - The new due date for the task as a long representing the number of milliseconds since January 1, 1970, 00:00:00 GMT.