com.jamasoftware.contour.ws.v3.domain
Class WsScope

java.lang.Object
  com.jamasoftware.contour.ws.v3.domain.WsScope

public class WsScope
extends java.lang.Object

WsScope is used to specify what type of Object is being looked for. This is often used in conjunction with a reference id (refId) to find a specific Object. For Example: If you are looking for a Project with an id of 3, your refId would be 3 and your scope would be WsScope.PROJECT.

Author:

Dylan

Field Summary

static java.lang.Integer	BASELINE The BaseLine scope is used for BaseLine-level activities, like signing a baseline, etc...
static java.lang.Integer	CONTOUR_ITEM The CONTOUR_ITEM scope is used for Item-level activities, like adding/removing Items, commenting on Items, etc...
static java.lang.Integer	DOCUMENT The Document scope is used for Item-level activities, like adding/removing Items, commenting on Items, etc...
static java.lang.Integer	DOCUMENT_TYPE The Document Type scope is used for Item Type-level activities, like adding/removing Item Types, changing the fields in an Item Type, etc...
static java.util.Map<java.lang.String,java.lang.Integer>	DOMAINNAME_SCOPE_MAP
static java.lang.Integer	FILTER The Filter scope is used for Filter-level activities, like adding/removing Filters, editing parameters for existing Filters, etc...
static java.lang.Integer	ORGANIZATION The Organization scope is used for Organization-level activities, like adding/removing Organizations.
static java.lang.Integer	PROJECT The Project scope is used for Project-level activities, like adding/removing Projects, changing per-Project settings, etc...
static java.lang.Integer	RELEASE The Release scope is used for Release-level activities, like adding/removing Releases, editing Release names, etc...
static java.lang.Integer	SMART_FILTER The Smart Filter scope is used for our new enhanced Filter-level activities, like adding/removing Filters, editing parameters for existing Filters, etc...
static java.lang.Integer	SYSTEM The System scope is used for fundamental Contour settings, like setting up SMTP servers, date formats, etc...
static java.lang.Integer	TEST_CYCLE The Test Cycle scope is used for Test Center Test Cycle activities.
static java.lang.Integer	TEST_PLAN The Test Plan scope is used for Test Center Test Plan activities.
static java.lang.Integer	TEST_RUN The Test Run scope is used for Test Center Test Run activities.
static java.lang.Integer	TEST_SET
static java.lang.Integer	USER The User scope is used for User-level activities, like adding/removing Users, changing passwords, etc...

Constructor Summary

WsScope()

Method Summary

static java.lang.Integer

getScopeForDomainName(java.lang.String domainName) Gets the scope id given the domain name of the object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SYSTEM

public static final java.lang.Integer SYSTEM

The System scope is used for fundamental Contour settings, like setting up SMTP servers, date formats, etc...

ORGANIZATION

public static final java.lang.Integer ORGANIZATION

The Organization scope is used for Organization-level activities, like adding/removing Organizations.

See Also:

WsOrganization

PROJECT

public static final java.lang.Integer PROJECT

The Project scope is used for Project-level activities, like adding/removing Projects, changing per-Project settings, etc...

See Also:

WsProject

DOCUMENT

public static final java.lang.Integer DOCUMENT

The Document scope is used for Item-level activities, like adding/removing Items, commenting on Items, etc...

See Also:

WsItem

USER

public static final java.lang.Integer USER

The User scope is used for User-level activities, like adding/removing Users, changing passwords, etc...

See Also:

WsUser

DOCUMENT_TYPE

public static final java.lang.Integer DOCUMENT_TYPE

The Document Type scope is used for Item Type-level activities, like adding/removing Item Types, changing the fields in an Item Type, etc...

See Also:

WsDocumentType

FILTER

public static final java.lang.Integer FILTER

The Filter scope is used for Filter-level activities, like adding/removing Filters, editing parameters for existing Filters, etc...

See Also:

WsFilter

RELEASE

public static final java.lang.Integer RELEASE

The Release scope is used for Release-level activities, like adding/removing Releases, editing Release names, etc...

See Also:

WsRelease

BASELINE

public static final java.lang.Integer BASELINE

The BaseLine scope is used for BaseLine-level activities, like signing a baseline, etc...

See Also:

WsBaseline

SMART_FILTER

public static final java.lang.Integer SMART_FILTER

The Smart Filter scope is used for our new enhanced Filter-level activities, like adding/removing Filters, editing parameters for existing Filters, etc...

See Also:

WsFilter

TEST_PLAN

public static final java.lang.Integer TEST_PLAN

The Test Plan scope is used for Test Center Test Plan activities.

TEST_CYCLE

public static final java.lang.Integer TEST_CYCLE

The Test Cycle scope is used for Test Center Test Cycle activities.

TEST_RUN

public static final java.lang.Integer TEST_RUN

The Test Run scope is used for Test Center Test Run activities.

CONTOUR_ITEM

public static final java.lang.Integer CONTOUR_ITEM

The CONTOUR_ITEM scope is used for Item-level activities, like adding/removing Items, commenting on Items, etc...

See Also:

WsItem

TEST_SET

public static final java.lang.Integer TEST_SET

DOMAINNAME_SCOPE_MAP

public static java.util.Map<java.lang.String,java.lang.Integer> DOMAINNAME_SCOPE_MAP

Constructor Detail

WsScope

public WsScope()

Method Detail

getScopeForDomainName

public static java.lang.Integer getScopeForDomainName(java.lang.String domainName)

Gets the scope id given the domain name of the object. For example: getScopeForDomainName("com.jamasoftware.contour.ws.v3.WsOrganization") will return WsScope.ORGANIZATION.

Parameters:

domainName - to get the scope of

Returns:

scope of the object with the given domain name