oracle.jdeveloper.vcs.vop

Interface VersionOperationModel

All Known Subinterfaces:

MutableVersionOperationModel

public interface VersionOperationModel

The version operation model describes the resources which are involved in a version operation panel.

Method Summary

Modifier and Type	Method and Description
void	addVersionOperationModelListener(VersionOperationModelListener l) Add a listener which will receive notification when the model changes.
Displayable	getCategory(Displayable item) Each item in the version operation panel can be categorized.
int	getCount() Get a count of the items in this model.
Displayable	getItem(int index) Get the item at the specified index in the model.
Displayable[]	getItems() Get the items in the model.
DisplayProperty[]	getProperties() Get metadata about available (read-only) properties for items in this model.
java.lang.Object	getPropertyValue(DisplayProperty property, int itemIndex) Get the value of the specified version operation property for the specified item.
boolean	isComplete() Get whether this model is fully constructed.
void	removeVersionOperationListener(VersionOperationModelListener l) Remove a listener previously added in the addVersionOperationModelListener() method.
void	setProperty(int itemIndex, DisplayProperty property, java.lang.Object value) Set the value of the specified version operation property for the specified item.

Method Detail

getCount

int getCount()

Get a count of the items in this model.

Returns:

a count of the items in the model.

isComplete

boolean isComplete()

Get whether this model is fully constructed. This can be used when asynchronously building the model to indicate to the view whether the asynchronous build of the model is complete yet.

Returns:

true if the model is fully constructed, false if the model is being asynchronously built or updated.

getItem

Displayable getItem(int index)

Get the item at the specified index in the model.

Parameters:

index - the model index of the item.

Returns:

an oracle.ide.model.Displayable for this item.

getItems

Displayable[] getItems()

Get the items in the model.

Returns:

an array of oracle.ide.model.Displayable for items.

getCategory

Displayable getCategory(Displayable item)

Each item in the version operation panel can be categorized. This can be used to e.g. group files by their parent directory.

Parameters:

item - one of the items in the getDisplayables() list.

Returns:

a displayable that is used as the category for the specified item, or null if the specified item is uncategorized.

getProperties

DisplayProperty[] getProperties()

Get metadata about available (read-only) properties for items in this model.

Returns:

an array of VersionOperationProperty instances, each of which describes a property of each item in the model. You can return an empty array or null.

getPropertyValue

java.lang.Object getPropertyValue(DisplayProperty property,
                                  int itemIndex)

Get the value of the specified version operation property for the specified item.

Parameters:

property - the property to get the value of

itemIndex - the index of the item whose property to get

Returns:

the value of the specified property.

setProperty

void setProperty(int itemIndex,
                 DisplayProperty property,
                 java.lang.Object value)

Set the value of the specified version operation property for the specified item.

Parameters:

itemIndex - the index of the item whose property to set

property - the property

value - The value object of the item

addVersionOperationModelListener

void addVersionOperationModelListener(VersionOperationModelListener l)

Add a listener which will receive notification when the model changes.

Parameters:

l - a listener which should be informed of changes to this model.

removeVersionOperationListener

void removeVersionOperationListener(VersionOperationModelListener l)

Remove a listener previously added in the addVersionOperationModelListener() method.

Parameters:

l - a listener to remove.