node.java

RESIN 3.2 最新源码

  /**
   * Returns the property based on the relative path.
   */
  public Property getProperty(String relPath)
    throws PathNotFoundException,
	   RepositoryException;
  
  /**
   * Returns the an iterator of the properties of the node.
   */
  public PropertyIterator getProperties()
    throws RepositoryException;
  
  /**
   * Returns the an iterator of the properties of the node matching
   * the pattern.
   */
  public PropertyIterator getProperties(String namePattern)
    throws RepositoryException;

  /**
   * Returns the node's primary item.
   */
  public Item getPrimaryItem()
    throws ItemNotFoundException,
	   RepositoryException;

  /**
   * Returns the node's UUID
   */
  public String getUUID()
    throws UnsupportedRepositoryOperationException,
	   RepositoryException;
  
  /**
   * Returns the node's index
   */
  public int getIndex()
    throws RepositoryException;
  
  /**
   * Returns the an iterator of the references
   */
  public PropertyIterator getReferences()
    throws RepositoryException;
  
  /**
   * Returns true if the path points to a node.
   *
   * @param relPath path to a property
   */
  public boolean hasNode(String relPath)
    throws RepositoryException;
  
  /**
   * Returns true if the path points to a property.
   *
   * @param relPath path to a property
   */
  public boolean hasProperty(String relPath)
    throws RepositoryException;
  
  /**
   * Returns true if the node has child nodes.
   */
  public boolean hasNodes()
    throws RepositoryException;
  
  /**
   * Returns true if the node has any properties.
   */
  public boolean hasProperties()
    throws RepositoryException;
  
  /**
   * Returns the node's primary type.
   */
  public NodeType getPrimaryNodeType()
    throws RepositoryException;
  
  /**
   * Returns any mixin types for the node.
   */
  public NodeType[] getMixinNodeTypes()
    throws RepositoryException;
  
  /**
   * Returns true if the node supports the given node tyep.
   */
  public boolean isNodeType(String nodeTypeName)
    throws RepositoryException;
  
  /**
   * Adds a mixin type to the node.
   */
  public void addMixin(String mixinName)
    throws NoSuchNodeTypeException,
	   VersionException,
	   ConstraintViolationException,
	   LockException,
	   RepositoryException;
  
  /**
   * Removes a mixin type to the node.
   */
  public void removeMixin(String mixinName)
    throws NoSuchNodeTypeException,
	   VersionException,
	   ConstraintViolationException,
	   LockException,
	   RepositoryException;
  
  /**
   * Returns true if the given mixin type can be added to the node.
   */
  public boolean canAddMixin(String mixinName)
    throws NoSuchNodeTypeException,
	   RepositoryException;
  
  /**
   * Returns a description of the node.
   */
  public NodeDefinition getDefinition()
    throws RepositoryException;
  
  /**
   * Checks in a new version for to the node.
   */
  public Version checkin()
    throws VersionException,
	   UnsupportedRepositoryOperationException,
	   InvalidItemStateException,
	   LockException,
	   RepositoryException;
  
  /**
   * Checks out a version.
   */
  public void checkout()
    throws UnsupportedRepositoryOperationException,
	   LockException,
	   RepositoryException;
  
  /**
   * Mark the version merge as complete.
   */
  public void doneMerge(Version version)
    throws VersionException,
	   InvalidItemStateException,
	   UnsupportedRepositoryOperationException,
	   RepositoryException;
  
  /**
   * Cancel a version merge.
   */
  public void cancelMerge(Version version)
    throws VersionException,
	   InvalidItemStateException,
	   UnsupportedRepositoryOperationException,
	   RepositoryException;
  
  /**
   * Updates a workspace
   */
  public void update(String srcWorkspaceName)
    throws NoSuchWorkspaceException,
	   AccessDeniedException,
	   LockException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Merges child nodes.
   */
  public NodeIterator merge(String srcWorkspace, boolean bestEffort)
    throws NoSuchWorkspaceException,
	   AccessDeniedException,
	   MergeException,
	   LockException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Returns the node path to a workspace.
   */
  public String getCorrespondingNodePath(String workspaceName)
    throws ItemNotFoundException,
	   NoSuchWorkspaceException,
	   AccessDeniedException,
	   RepositoryException;
  
  /**
   * Returns true for a checked out node.
   */
  public boolean isCheckedOut()
    throws RepositoryException;
  
  /**
   * Restore the node based on an older version.
   */
  public void restore(String versionName, boolean removeExisting)
    throws VersionException,
	   ItemExistsException,
	   UnsupportedRepositoryOperationException,
	   LockException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Restore the node based on an older version.
   */
  public void restore(Version version, boolean removeExisting)
    throws VersionException,
	   ItemExistsException,
	   UnsupportedRepositoryOperationException,
	   LockException,
	   RepositoryException;
  
  /**
   * Restore the node based on an older version.
   */
  public void restore(Version version,
		      String relPath,
		      boolean removeExisting)
    throws PathNotFoundException,
	   ItemExistsException,
	   VersionException,
	   ConstraintViolationException,
	   UnsupportedRepositoryOperationException,
	   LockException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Restore the node based on an older version.
   */
  public void restoreByLabel(String versionLabel,
			     boolean removeExisting)
    throws VersionException,
	   ItemExistsException,
	   UnsupportedRepositoryOperationException,
	   LockException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Returns the node's version history.
   */
  public VersionHistory getVersionHistory()
    throws UnsupportedRepositoryOperationException,
	   RepositoryException;
  
  /**
   * Returns the base version.
   */
  public Version getBaseVersion()
    throws UnsupportedRepositoryOperationException,
	   RepositoryException;
  
  /**
   * Lock the node.
   */
  public Lock lock(boolean isDeep, boolean isSessionScoped)
    throws UnsupportedRepositoryOperationException,
	   LockException,
	   AccessDeniedException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Returns the current lock.
   */
  public Lock getLock()
    throws UnsupportedRepositoryOperationException,
	   LockException,
	   AccessDeniedException,
	   RepositoryException;
  
  /**
   * Unlocks the node.
   */
  public void unlock()
    throws UnsupportedRepositoryOperationException,
	   LockException,
	   AccessDeniedException,
	   InvalidItemStateException,
	   RepositoryException;
  
  /**
   * Returns true if the node owns a lock.
   */
  public boolean holdsLock()
    throws RepositoryException;
  
  /**
   * Returns true if the node is locked.
   */
  public boolean isLocked()
    throws RepositoryException;
}