net.praqma.clearcase.ucm.entities

Class Project

java.lang.Object

net.praqma.clearcase.Cool

net.praqma.clearcase.ClearCase

net.praqma.clearcase.ucm.entities.UCMEntity

net.praqma.clearcase.ucm.entities.Project

All Implemented Interfaces:

Serializable, StreamContainable

public class Project
extends UCMEntity
implements StreamContainable

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Project.PromotionLevel

Nested classes/interfaces inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

UCMEntity.Kind, UCMEntity.LabelStatus

Field Summary

Fields

Modifier and Type	Field and Description
static int	POLICY_CHSTREAM_UNRESTRICTED
static int	POLICY_DELIVER_NCO_DEVSTR
static int	POLICY_DELIVER_REQUIRE_REBASE
static int	POLICY_INTERPROJECT_DELIVER Enables inter-project deliveries

Fields inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

date, dateFormatter, fqname, kind, labelStatus, loaded, mastership, pattern_std_fqname, pattern_tag_fqname, pattern_version_fqname, pvob, rx_ccdef_allowed, rx_ccdef_cc_name, rx_ccdef_filename, rx_ccdef_vob, shortname, user, vob

Fields inherited from class net.praqma.clearcase.ClearCase

rx_attr_find

Fields inherited from class net.praqma.clearcase.Cool

delim, filesep, filesepChar, linesep, qfs, qfsor

Method Summary

Modifier and Type	Method and Description
static Project	create(String name, String root, PVob pvob, int policy, String comment, boolean normal, Component mcomps)
static Project	create(String name, String root, PVob pvob, int policy, String comment, boolean normal, List<Component> mcomps) Create a project.
static Project	get(String name)
static Project	get(String name, PVob pvob)
Stream	getIntegrationStream()
List<Component>	getModifiableComponents() Get a list of modifiable Components for this Project from ClearCase
List<Component>	getNonModifiableComponents()
static Project.PromotionLevel	getPlevelFromString(String str)
static String	getPolicy(int policy)
static int	getPolicyValue(String policy)
static List<Project>	getProjects(PVob pvob) Get the list of Projects in a given PVob
static List<String>	getPromotionLevels()
List<Stream>	getStreams()
Project	load() Default load functionality for the entity.
static Project.PromotionLevel	promoteFrom(Project.PromotionLevel plevel)
void	remove() Remove this Project from ClearCase
void	setStream(Stream stream) Set the integration Stream for this Project object

Methods inherited from class net.praqma.clearcase.ucm.entities.UCMEntity

autoLoad, changeOwnership, changeOwnership, equals, getargComment, getargIn, getComment, getDate, getEntity, getEntity, getEntitySelector, getFqname, getFullyQualifiedName, getHyperlinks, getKind, getLabelStatus, getLabelStatusFromString, getMastership, getNamePart, getNormalizedName, getObjectId, getObjectId, getPVob, getShortname, getTag, getUser, hashCode, initialize, isCreated, isLoaded, loadDate, setComment, setCreated, setDate, setDate, setFqname, setKind, setLabelStatusFromString, setMastership, setUser, stringify, toString

Methods inherited from class net.praqma.clearcase.ClearCase

createSimpleAttributeType, getAttribute, getAttributes, getAttributes, getAttributes, setAttribute, setAttribute

Methods inherited from class net.praqma.clearcase.Cool

getOS

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.praqma.clearcase.interfaces.StreamContainable

getFullyQualifiedName, getPVob

Field Detail

POLICY_INTERPROJECT_DELIVER

public static final int POLICY_INTERPROJECT_DELIVER

Enables inter-project deliveries

See Also:

Constant Field Values

POLICY_CHSTREAM_UNRESTRICTED

public static final int POLICY_CHSTREAM_UNRESTRICTED

See Also:

Constant Field Values

POLICY_DELIVER_REQUIRE_REBASE

public static final int POLICY_DELIVER_REQUIRE_REBASE

See Also:

Constant Field Values

POLICY_DELIVER_NCO_DEVSTR

public static final int POLICY_DELIVER_NCO_DEVSTR

See Also:

Constant Field Values

Method Detail

getPlevelFromString

public static Project.PromotionLevel getPlevelFromString(String str)

promoteFrom

public static Project.PromotionLevel promoteFrom(Project.PromotionLevel plevel)

getPolicy

public static String getPolicy(int policy)

getPolicyValue

public static int getPolicyValue(String policy)

create

public static Project create(String name,
                             String root,
                             PVob pvob,
                             int policy,
                             String comment,
                             boolean normal,
                             Component mcomps)
                      throws UnableToCreateEntityException,
                             UnableToInitializeEntityException

Throws:

UnableToCreateEntityException

UnableToInitializeEntityException

create

public static Project create(String name,
                             String root,
                             PVob pvob,
                             int policy,
                             String comment,
                             boolean normal,
                             List<Component> mcomps)
                      throws UnableToCreateEntityException,
                             UnableToInitializeEntityException

Create a project.

Parameters:

name - The name of the Project

root - If not null, the root folder of the project

pvob - The PVob}

policy - Policies as integer

comment - If not null, the comment of the project

normal - Normal

mcomps - Modifiable components of the project

Returns:

a new Project

Throws:

UnableToCreateEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

load

public Project load()
             throws UnableToLoadEntityException,
                    UnableToInitializeEntityException

Description copied from class: UCMEntity

Default load functionality for the entity. Every UCM entity should implement this method itself.

Overrides:

load in class UCMEntity

Returns:

The current UCMEntity

Throws:

UnableToLoadEntityException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

setStream

public void setStream(Stream stream)

Set the integration Stream for this Project object

Parameters:

stream - Set the Stream

getIntegrationStream

public Stream getIntegrationStream()

getStreams

public List<Stream> getStreams()
                        throws CleartoolException

Throws:

CleartoolException

getPromotionLevels

public static List<String> getPromotionLevels()

getProjects

public static List<Project> getProjects(PVob pvob)
                                 throws UnableToListProjectsException,
                                        UnableToInitializeEntityException

Get the list of Projects in a given PVob

Parameters:

pvob - The PVob

Returns:

A list of Projects under the given PVob

Throws:

UnableToListProjectsException - Thrown when ClearCase reports errors

UnableToInitializeEntityException - Thrown when ClearCase reports errors

getModifiableComponents

public List<Component> getModifiableComponents()
                                        throws UnableToInitializeEntityException,
                                               CleartoolException

Get a list of modifiable Components for this Project from ClearCase

Returns:

A list of Component

Throws:

UnableToInitializeEntityException - Thrown when ClearCase reports errors

CleartoolException - Thrown when ClearCase reports errors

getNonModifiableComponents

public List<Component> getNonModifiableComponents()
                                           throws UnableToInitializeEntityException,
                                                  CleartoolException

Throws:

UnableToInitializeEntityException

CleartoolException

remove

public void remove()
            throws UnableToRemoveEntityException

Remove this Project from ClearCase

Throws:

UnableToRemoveEntityException - Thrown when ClearCase reports errors

get

public static Project get(String name,
                          PVob pvob)
                   throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException

get

public static Project get(String name)
                   throws UnableToInitializeEntityException

Throws:

UnableToInitializeEntityException