IVersionedDocumentHandler Interface

com.bea.ide.document
IVersionedDocumentHandler Interface

public interface IVersionedDocumentHandler

    extends IDocumentHandler

This interface extends IDocumentHandler with the ability to obtain information about versioning for documents without having to instantiate a document object. Both the handler and the IVersionedDocument interfaces must be implemented to insure correct behavior with the IDE architecture.


All Superinterfaces
IDocumentHandler

Nested Class Summary

 
Nested classes from interface com.bea.ide.document.IDocumentHandler
IDocumentHandler.IHandlerContext, IDocumentHandler.Priority
 

Method Summary

public String
getVirtualName(URI uri)
Obtain the virtual name for this document.
public boolean
isDefaultVersion(URI uri)
Determines whether this document instance is the default version.
public boolean
isValidVersion(URI uri)
Indicates whether the document is currently a valid version.
 
Methods from interface com.bea.ide.document.IDocumentHandler
createNewFile, getBaseName, getDefaultExtension, getHandlerId, invalidNameCheck, openDocument, resolveUnknownPriority, suggestValidName
   

Method Detail

getVirtualName(URI) Method

public String getVirtualName(URI uri)
Obtain the virtual name for this document. All documents that share a virtual name are versions of the same document.

Returns

String representing the virtual name for this document or null if the URI does not refer to a version instance

isDefaultVersion(URI) Method

public boolean isDefaultVersion(URI uri)
Determines whether this document instance is the default version. The default version is the one that will be associated with the virtual name when invoked (ex. when invoking a webservice using the virtual .jws. Note that if the URI does not refer to a version instance (i.e. getVirtualName() returns null), this method should return false

Returns

true if this instance is the default version, false otherwise

isValidVersion(URI) Method

public boolean isValidVersion(URI uri)
Indicates whether the document is currently a valid version. If the document does not properly implement the version's interface, then this method should return true in order to allow feedback to the user.

Returns

true if the document implements the versions interface correctly, false otherwise