|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
com.microsoft.tfs.core.clients.versioncontrol.soapextensions.ChangeRequest
public class ChangeRequest
Contains information about an change a user is making to a version control resource.
Field Summary |
---|
Fields inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper |
---|
webServiceObject |
Constructor Summary | |
---|---|
ChangeRequest(ms.tfs.versioncontrol.clientservices._03._ChangeRequest request)
Construct a ChangeRequest . |
|
ChangeRequest(ItemSpec item,
VersionSpec version,
RequestType requestType,
ItemType itemType,
int encoding,
LockLevel lockLevel,
int deletionID,
java.lang.String targetItem,
boolean detectTargetItemType)
Creates a ChangeRequest for the given item at the given version. |
Method Summary | |
---|---|
static ChangeRequest[] |
fromSpecs(ItemSpec[] specs,
RequestType requestType,
LockLevel[] lockLevel,
FileEncoding[] fileEncoding)
Create change requests from an array of specs. |
static ChangeRequest[] |
fromStrings(java.lang.String[] paths,
RequestType requestType,
LockLevel[] lockLevel,
RecursionType recursionType,
FileEncoding[] fileEncoding)
Create change requests from an array of string paths. |
int |
getDeletionID()
|
int |
getEncoding()
|
ItemSpec |
getItemSpec()
|
ItemType |
getItemType()
|
LockLevel |
getLockLevel()
|
PropertyValue[] |
getProperties()
|
RequestType |
getRequestType()
|
java.lang.String |
getTargetItem()
|
ItemType |
getTargetItemType()
|
VersionSpec |
getVersionSpec()
|
ms.tfs.versioncontrol.clientservices._03._ChangeRequest |
getWebServiceObject()
Gets the web service object this class wraps. |
void |
setDeletionID(int did)
|
void |
setEncoding(int enc)
|
void |
setItemSpec(ItemSpec item)
|
void |
setItemType(ItemType type)
|
void |
setLockLevel(LockLevel lock)
|
void |
setProperties(PropertyValue[] properties)
|
void |
setRequestType(RequestType req)
|
void |
setTargetItem(java.lang.String target)
|
void |
setTargetItemType(ItemType targettype)
|
void |
setVersionSpec(VersionSpec vspec)
|
java.lang.String |
toString()
|
Methods inherited from class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper |
---|
equals, hashCode |
Methods inherited from class java.lang.Object |
---|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait |
Constructor Detail |
---|
public ChangeRequest(ms.tfs.versioncontrol.clientservices._03._ChangeRequest request) throws ChangeRequestValidationException
ChangeRequest
.
request
- the request object to use as default values. All local paths in
this request object must be absolute.
ChangeRequestValidationException
- if this request fails validation.public ChangeRequest(ItemSpec item, VersionSpec version, RequestType requestType, ItemType itemType, int encoding, LockLevel lockLevel, int deletionID, java.lang.String targetItem, boolean detectTargetItemType) throws ChangeRequestValidationException
ChangeRequest
for the given item at the given version.
item
- the item to change (must not be null
)version
- the version of the item to change (may be null
to let
the server apply the default version appropriate for the path)requestType
- the type of change requested (must not be null
)itemType
- the type of item (may be null
if detectTargetItemType
is true, otherwise not null
)encoding
- the item's encoding (must not be null
)lockLevel
- the lock level desired (must not be null
)deletionID
- the deletion ID of the itemtargetItem
- the target item (may be null if the change does not require a
different target item)detectTargetItemType
- true to examine the item's local representation to determine the
type (file or folder), false to use the given item type (which
must not be null)
ChangeRequestValidationException
- if the change request is not valid after parameters are
interpretedMethod Detail |
---|
public ms.tfs.versioncontrol.clientservices._03._ChangeRequest getWebServiceObject()
public int getDeletionID()
public int getEncoding()
public ItemSpec getItemSpec()
public LockLevel getLockLevel()
public RequestType getRequestType()
public java.lang.String getTargetItem()
public ItemType getTargetItemType()
public ItemType getItemType()
public VersionSpec getVersionSpec()
public void setDeletionID(int did)
public void setEncoding(int enc)
public void setItemSpec(ItemSpec item)
public void setLockLevel(LockLevel lock)
public void setRequestType(RequestType req)
public void setTargetItem(java.lang.String target)
public void setTargetItemType(ItemType targettype)
public void setItemType(ItemType type)
public void setVersionSpec(VersionSpec vspec)
public PropertyValue[] getProperties()
public void setProperties(PropertyValue[] properties)
public static ChangeRequest[] fromStrings(java.lang.String[] paths, RequestType requestType, LockLevel[] lockLevel, RecursionType recursionType, FileEncoding[] fileEncoding) throws ChangeRequestValidationException
paths
- the local disk or server paths of files or folders to create a
change request for (must not be null
) Local paths
will be canonicalized (therefore made absolute). Any server paths
will not have their encoding automatically detected. (must not be
null
)requestType
- the type of change that is being requested.lockLevel
- an array containing the lock level for each file.recursionType
- what kind of recursion to perform on the paths supplied as the
first argument.fileEncoding
- an array containing the encoding for each item spec, or null to
indicate that the encoding is unchanged. If the array is null,
VersionControlConstants.ENCODING_UNCHANGED
is used for
all.
ChangeRequestValidationException
- if an error occurred constructing an AChangeRequest because a
local disk file could not be examined.public static ChangeRequest[] fromSpecs(ItemSpec[] specs, RequestType requestType, LockLevel[] lockLevel, FileEncoding[] fileEncoding) throws ChangeRequestValidationException
specs
- the items specs to create requests for. Local paths will be
canonicalized (therefore made absolute). Any server paths will not
have their encoding automatically detected. (must not be
null
)requestType
- the type of change that is being requested.lockLevel
- an array containing the lock level for each item spec.fileEncoding
- an array containing the encoding for each item spec, or null to
indicate that the encoding is unchanged. If the array is null,
VersionControlConstants.ENCODING_UNCHANGED
is used for
all.
ChangeRequestValidationException
- if an error occurred constructing an AChangeRequest because a
local disk file could not be examined.public java.lang.String toString()
toString
in class com.microsoft.tfs.core.internal.wrappers.WebServiceObjectWrapper
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |