|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ControllableFolder
A ControllableFolder is a folder that can be placed under control.
A "configuration" is the set of resources consisting of all members of a controllable folder (called the "root folder" for the configuration).
When a controllable folder is placed under version control, a version of that folder only captures the named mappings to version controlled members of that folder. In order to version control the entire configuration rooted at a folder, the folder must be placed under "baseline control".
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface javax.wvcm.ControllableResource |
---|
ControllableResource.Conflict, ControllableResource.Ignore, ControllableResource.MergePreviewReport, ControllableResource.Update |
Nested classes/interfaces inherited from interface javax.wvcm.Folder |
---|
Folder.Binding |
Nested classes/interfaces inherited from interface javax.wvcm.Resource |
---|
Resource.GenericResourceImpl |
Method Summary | |
---|---|
void |
doBaselineControl()
Put this ControllableFolder under baseline control. |
void |
doBaselineControl(Baseline baseline)
Put this ControllableFolder under baseline control and initialize
it with the contents of the specified baseline. |
java.util.List |
doLocateByHistoryReport(java.util.List versionHistoryList,
PropertyNameList wantedPropertyList)
NOT YET STANDARD *** This method is normally retricted to Workspace *** Return a list of ControllableResource objects
that identify the controllable resources that are members of
this ControllableFolder and whose versionHistory property identifies
a member of the versionHistoryList parameter. |
boolean |
getBaselineControllable()
Return whether the folder can be put under baseline control. |
java.util.List |
getEclipsedList()
Return a list of String objects that identify the names of version-controlled resources in this ControllableFolder
that are eclipsed by non-version-controlled resources. |
java.util.Iterator |
readMemberList(PropertyNameList wantedPropertyList,
boolean deep)
Return an iterator of Resource objects that contain locally
available properties of the resources that are locally known
as members of this Folder . |
Methods inherited from interface javax.wvcm.Folder |
---|
doReadMemberList, getBindingList |
Method Detail |
---|
java.util.Iterator readMemberList(PropertyNameList wantedPropertyList, boolean deep) throws WvcmException
Resource
objects that contain locally
available properties of the resources that are locally known
as members of this Folder
. Locally available information is
information that is available on the client host
without communicating with the server.
wantedPropertyList
- The list of properties to be retrieved.deep
- Whether to retrieve properties for all members of this Folder
.
WvcmException
Folder.doReadMemberList(javax.wvcm.PropertyNameList, boolean)
void doBaselineControl() throws WvcmException
ControllableFolder
under baseline control.
A version-controlled configuration resource is associated with
this ControllableFolder
, which allows versions of the configuration rooted at
this ControllableFolder
to be created by checking out and checking in the
version-controlled configuration resource.
A version of a configuration is called a "baseline".
WvcmException
- Preconditions:
WvcmException
- Postconditions:
void doBaselineControl(Baseline baseline) throws WvcmException
ControllableFolder
under baseline control and initialize
it with the contents of the specified baseline.
baseline
- The baseline used to initialize the folder.
WvcmException
- Preconditions:
WvcmException
- Postconditions:
java.util.List getEclipsedList() throws WvcmException
ControllableFolder
that are eclipsed by non-version-controlled resources.
WvcmException
- if this ControllableFolder
was not created with
ECLIPSED_LIST
as a wanted property.boolean getBaselineControllable() throws WvcmException
WvcmException
- if this ControllableFolder
was not created with
BASELINE_CONTROLLABLE
as a wanted property.doBaselineControl()
java.util.List doLocateByHistoryReport(java.util.List versionHistoryList, PropertyNameList wantedPropertyList) throws WvcmException
ControllableResource
objects
that identify the controllable resources that are members of
this ControllableFolder
and whose versionHistory property identifies
a member of the versionHistoryList
parameter.
versionHistoryList
- A list of VersionHistory
objects that
are being located.wantedPropertyList
- The properties to be retrieved for the
returned version-controlled resources.
WvcmException
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |