com.atlassian.bamboo.deployments.environments
Interface InternalEnvironment

All Superinterfaces:
BambooIdProvider, DescriptionProvider, NameProvider, Triggerable
All Known Subinterfaces:
Environment, MutableEnvironment
All Known Implementing Classes:
EnvironmentImpl, MutableEnvironmentImpl

public interface InternalEnvironment
extends BambooIdProvider, NameProvider, DescriptionProvider, Triggerable

Common interface between all types of deployment environments. Defines relationship between client side objects and db objects. Though probably not useful for anything else. Be wary when adding things to this interface - be sure it makes sense in all contexts.


Method Summary
 ConfigurationState getConfigurationState()
           
 java.lang.String getDescription()
           
 long getId()
           
 DeploymentKey getKey()
          Key representing this environment.
 java.lang.String getName()
           
 int getPosition()
           
 
Methods inherited from interface com.atlassian.bamboo.trigger.Triggerable
getTriggers, isSuspended
 

Method Detail

getId

long getId()
Specified by:
getId in interface BambooIdProvider
Returns:
unique identifier (in this case from database)

getKey

@NotNull
DeploymentKey getKey()
Key representing this environment. Keys have much less significance in deployments than in plans. Please consider using getId() instead.

Returns:
key of this environment.

getName

@NotNull
java.lang.String getName()
Specified by:
getName in interface DescriptionProvider
Specified by:
getName in interface NameProvider
Returns:
User friendly shortish name for this environment. Must be unique within a deployment project

getDescription

@Nullable
java.lang.String getDescription()
Specified by:
getDescription in interface DescriptionProvider
Returns:
Optional, longer description of the environment

getConfigurationState

ConfigurationState getConfigurationState()
Returns:
Enum representing how completed the configuration of this environments is.

getPosition

int getPosition()
Returns:
position of this environment in deployment project's environment list.


Copyright © 2013 Atlassian Software Systems Pty Ltd. All Rights Reserved.