public class ServiceDocument extends Element implements IServiceDocument
Modifier and Type | Field and Description |
---|---|
static ElementKey<java.lang.Void,ServiceDocument> |
KEY
The key for this element.
|
Modifier | Constructor and Description |
---|---|
|
ServiceDocument()
Constructs an instance using the default key.
|
protected |
ServiceDocument(ElementKey<?,? extends ServiceDocument> key)
Subclass constructor, allows subclasses to supply their own element key.
|
protected |
ServiceDocument(ElementKey<?,? extends ServiceDocument> key,
Element source)
Constructs a new instance by doing a shallow copy of data from an existing
Element instance. |
Modifier and Type | Method and Description |
---|---|
Workspace |
addWorkspace(java.lang.String title)
Add a new workspace to the service document, returning the newly created
workspace to the caller.
|
ServiceDocument |
addWorkspace(Workspace workspace)
Adds a new workspace.
|
void |
clearWorkspaces()
Removes all existing workspace instances.
|
java.util.List<Workspace> |
getWorkspaces()
Returns the workspaces.
|
boolean |
hasWorkspaces()
Returns whether it has the workspaces.
|
ServiceDocument |
lock()
Locks this element.
|
static void |
registerMetadata(MetadataRegistry registry)
Registers the metadata for this element.
|
boolean |
removeWorkspace(Workspace workspace)
Removes an existing workspace.
|
adapt, adapt, addElement, addElement, addElement, clear, createElement, createElement, eq, equals, getAttributeCount, getAttributeIterator, getAttributeIterator, getAttributeValue, getAttributeValue, getDefaultKey, getElement, getElement, getElementCount, getElementId, getElementIterator, getElementIterator, getElementKey, getElements, getElements, getElementSet, getElementSet, getElementValue, getElementValue, getTextValue, getTextValue, hasAttribute, hasAttribute, hasElement, hasElement, hashCode, hasTextValue, isLocked, narrow, removeAttribute, removeAttribute, removeAttributeValue, removeAttributeValue, removeElement, removeElement, removeElement, removeElement, replaceElement, resolve, resolve, sameClassAs, setAttributeValue, setAttributeValue, setElement, setElement, setElement, setTextValue, toString, validate, visit
public static final ElementKey<java.lang.Void,ServiceDocument> KEY
public ServiceDocument()
protected ServiceDocument(ElementKey<?,? extends ServiceDocument> key)
protected ServiceDocument(ElementKey<?,? extends ServiceDocument> key, Element source)
Element
instance. Will use the given ElementKey
as the key
for the element. This constructor is used when adapting from one element
key to another. You cannot call this constructor directly, instead use
Element.createElement(ElementKey, Element)
.key
- The key to use for this element.source
- source elementpublic static void registerMetadata(MetadataRegistry registry)
public ServiceDocument lock()
Element
public java.util.List<Workspace> getWorkspaces()
getWorkspaces
in interface IServiceDocument
public ServiceDocument addWorkspace(Workspace workspace)
workspace
- workspacepublic boolean removeWorkspace(Workspace workspace)
workspace
- workspacepublic void clearWorkspaces()
public boolean hasWorkspaces()
public Workspace addWorkspace(java.lang.String title)
IServiceDocument
addWorkspace
in interface IServiceDocument