flux.repository
Interface RepositoryElement

All Superinterfaces:

java.io.Serializable

public interface RepositoryElement
extends java.io.Serializable

Represents a template workflow, an engine configuration, an agent configuration, a PGP key, or a business interval in the repository.

Author:

Copyright 2014 Flux Corporation. All rights reserved.

Method Summary

java.lang.Object	get() Returns the specific object that this repository element represents.
AgentConfiguration	getAgentConfiguration() Returns this repository element specifically as an agent configuration.
AllowableBusinessInterval	getBusinessInterval() Returns this repository element specifically as a business interval.
java.util.Date	getCreationTimestamp() Returns the date when this repository element was added to the repository.
java.lang.String	getDescription() Returns the description of this element in the repository.
Configuration	getEngineConfiguration() Returns this repository element specifically as an engine configuration.
FlowChart	getFlowChart() Returns this repository element specifically as a flow chart.
java.util.Date	getLastModifiedTimestamp() Returns the date when this repository element was last modified in the repository.
java.lang.String	getNamespace() Returns the fully qualified name of this repository element.
java.lang.String	getOwner() Returns the username of the user who inserted this element in the repository.
PgpKeyPair	getPgpKeyPair() Returns this repository element specifically as a PGP key pair.
RepositoryElementType	getType() Returns the type for this repository element.
boolean	isAgentConfiguration() Indicates whether this repository element is an agent configuration.
boolean	isBusinessInterval() Indicates whether this repository element is a business interval.
boolean	isEngineConfiguration() Indicates whether this repository element is an engine configuration.
boolean	isFlowChart() Indicates whether this repository element is a workflow.
boolean	isPgpKeyPair() Indicates whether this repository element is a PGP key pair.

Method Detail

get

java.lang.Object get()
                     throws EngineException

Returns the specific object that this repository element represents. Object returned will be an instance of either flux.FlowChart or flux.Configuration or flux.agent.AgentConfiguration.

Returns:

An element from the repository.

Throws:

EngineException - If a system error occurs.

getAgentConfiguration

AgentConfiguration getAgentConfiguration()
                                         throws EngineException

Returns this repository element specifically as an agent configuration.

Returns:

This repository element specifically as an agent configuration.

Throws:

EngineException - If a system error occurs.

getBusinessInterval

AllowableBusinessInterval getBusinessInterval()
                                              throws EngineException

Returns this repository element specifically as a business interval.

Returns:

This repository element specifically as a business interval.

Throws:

EngineException - If a system error occurs.

getCreationTimestamp

java.util.Date getCreationTimestamp()

Returns the date when this repository element was added to the repository.

Returns:

The date when this repository element was added to the repository.

getDescription

java.lang.String getDescription()

Returns the description of this element in the repository. The description is displayed in the Flux Operations Console to describe the function of the repository element for the user.

Returns:

The description of this element in the repository.

getEngineConfiguration

Configuration getEngineConfiguration()
                                     throws EngineException

Returns this repository element specifically as an engine configuration.

Returns:

This repository element specifically as an engine configuration.

Throws:

EngineException - If a system error occurs.

getFlowChart

FlowChart getFlowChart()
                       throws EngineException

Returns this repository element specifically as a flow chart.

Returns:

This repository element specifically as a flow chart.

Throws:

EngineException - If a system error occurs.

getLastModifiedTimestamp

java.util.Date getLastModifiedTimestamp()

Returns the date when this repository element was last modified in the repository.

Returns:

The date when this repository element was last modified in the repository.

getNamespace

java.lang.String getNamespace()

Returns the fully qualified name of this repository element.

Returns:

The fully qualified name of this repository element.

getOwner

java.lang.String getOwner()

Returns the username of the user who inserted this element in the repository.

Returns:

The username of the user who inserted this element in the repository.

getPgpKeyPair

PgpKeyPair getPgpKeyPair()
                         throws EngineException

Returns this repository element specifically as a PGP key pair.

Returns:

This repository element specifically as a PGP key pair.

Throws:

EngineException

getType

RepositoryElementType getType()

Returns the type for this repository element.

Returns:

The type for this repository element.

isAgentConfiguration

boolean isAgentConfiguration()

Indicates whether this repository element is an agent configuration.

Returns:

Whether this repository element is an agent configuration.

isBusinessInterval

boolean isBusinessInterval()

Indicates whether this repository element is a business interval.

Returns:

Whether this repository element is a business interval.

isEngineConfiguration

boolean isEngineConfiguration()

Indicates whether this repository element is an engine configuration.

Returns:

Whether this repository element is an engine configuration.

isFlowChart

boolean isFlowChart()

Indicates whether this repository element is a workflow.

Returns:

Whether this repository element is a workflow.

isPgpKeyPair

boolean isPgpKeyPair()

Indicates whether this repository element is a PGP key pair.

Returns:

Whether this repository element is a PGP key pair.