|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface QueryItem
Base query item class, representing any hierarchical query node (a
QueryFolder
or a QueryDefinition
).
Method Summary | |
---|---|
void |
delete()
Deletes this query item from the server. |
com.microsoft.tfs.util.GUID |
getID()
Returns the unique ID for this QueryItem. |
java.lang.String |
getName()
Gets the name of this query item. |
java.lang.String |
getOriginalName()
Gets the original name of this query item, before any unsaved modifications were made to the hierarchy. |
IdentityDescriptor |
getOriginalOwnerDescriptor()
Gets the original owner's IdentityDescriptor for this query item,
before any unsaved modifications were made to the hierarchy. |
QueryFolder |
getOriginalParent()
Gets the original parent folder of this query item, before any unsaved modifications were made to the hierarchy. |
IdentityDescriptor |
getOwnerDescriptor()
Gets the owner's IdentityDescriptor for this query item. |
QueryFolder |
getParent()
Gets the parent folder of this query item. |
Project |
getProject()
Returns the Project that this QueryItem is associated
with. |
QueryItemType |
getType()
Gets the QueryItemType for this query item, determining whether
it is a Team Project (ie, the query hierarchy root), a query folder or a
query definition. |
boolean |
isDeleted()
Queries the deletion state of this query item. |
boolean |
isDirty()
Determines whether this query item is dirty and has changes that have not been saved to the server, including creation or deletion. |
boolean |
isNew()
Determines whether this query item is newly created and has not yet been saved to the server. |
boolean |
isPersonal()
Determines whether this is a personal (private to the owner) query item. |
void |
setName(java.lang.String name)
Sets the name of this item. |
void |
setOwnerDescriptor(IdentityDescriptor ownerDescriptor)
Sets the owner of this query item to be the given IdentityDescriptor . |
Method Detail |
---|
com.microsoft.tfs.util.GUID getID()
Project getProject()
Project
that this QueryItem
is associated
with. Will return null
if this is a newly created
QueryItem
with no project associated.
Project
this QueryItem
is associated with, or
null
.java.lang.String getName()
java.lang.String getOriginalName()
void setName(java.lang.String name)
name
- The new name for this item (not null
).QueryFolder getParent()
QueryFolder
, or null
if this item
is the hierarchy root.QueryFolder getOriginalParent()
QueryFolder
, or null
if this item
is the hierarchy root.IdentityDescriptor getOwnerDescriptor()
IdentityDescriptor
for this query item.
IdentityDescriptor
.IdentityDescriptor getOriginalOwnerDescriptor()
IdentityDescriptor
for this query item,
before any unsaved modifications were made to the hierarchy.
IdentityDescriptor
.void setOwnerDescriptor(IdentityDescriptor ownerDescriptor)
IdentityDescriptor
.
ownerDescriptor
- The new owner's IdentityDescriptor
.
WorkItemException
- if this server does not support permissions on query items.void delete()
WorkItemException
- if this query item cannot be deleted because it has already been
deleted or it is the query hierarchy root.boolean isDeleted()
true
if this query item has been removed from the
hierarchy, false
otherwise.boolean isPersonal()
true
if this query item is personal,
false
otherwise.boolean isNew()
true
if this query item is new, false
otherwise.boolean isDirty()
true
if this query item is dirty, false
otherwise.QueryItemType getType()
QueryItemType
for this query item, determining whether
it is a Team Project (ie, the query hierarchy root), a query folder or a
query definition.
QueryItemType
for this query item.
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |