ext.sulis

Class SulisLoadHelper

Object

SulisLoadHelper

All Implemented Interfaces:

RemoteAccess

public class SulisLoadHelper
extends Object
implements RemoteAccess

load related stuff moved from statichelper

Author:

mkraegeloh

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_UNIT
static String	DEPARTMENT
static String	DESCRIPTION
static String	DOCTYPE
static String	DRAWING_SUB_TYPE
static String	DRAWING_TYPE
static Method	getSortValue
static String	IS_PHANTOM
static String	LIFE_CYCLE
static int	MAJOR
static int	MINOR
static String	OIR
static String	PART_TYPE
static String	SERIES
static boolean	SERVER
static String	SOURCE
static String	STATE
static String	TEAM
static String	TEMPLATE_NAME
static String	TYPE
static String	VIEW
static String	WEBJECT
static String	WTHOME

Fields inherited from interface RemoteAccess

versionID

Constructor Summary

Constructors

Constructor and Description
SulisLoadHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static void	checkForVersion(String seriesID, String version, boolean createMissingVersion) check if "version" has been initialized (= used) if createMissingVersion is true and version has not been initialized (eg used) yet than the function tries to create the missing version.
static int	compareVersions(String seriesID, String versionA, String versionB) compare two versions , returns greater zero versionA < versionB, zero if versions are queal, and a negative int if versionA > versionB
static int	compareVersions(String seriesID, String versionA, String versionB, boolean createMissingVersion) compare two versions , returns greater zero versionA < versionB, zero if versions are queal, and a negative int if versionA > versionB if createMissingVersion is true and versionA or versionB have not been initialized (eg used) yet than the functions tries to create the missing version.
static EPMDocument	createEPMDoc(String docNumber, String docName, String cadName, String container, String folder, String versionID, String iterationID, File[] binaryContent) see method with full argument list - this one passes an empty moreData Map to method with next singature
static EPMDocument	createEPMDoc(String docNumber, String docName, String cadName, String container, String folder, String versionID, String iterationID, File[] binaryContent, EPMAuthoringAppType authoringApp, EPMAuthoringAppVersion appVersion) see method with full argument list - this one passes an empty moreData Map
static EPMDocument	createEPMDoc(String docNumber, String docName, String cadName, String container, String folder, String versionID, String iterationID, Map moreData, File[] binaryContent) see method with full argument list - this one passes PROE as authoringApplication and 28 L-01 as app version
static EPMDocument	createEPMDoc(String docNumber, String docName, String cadName, String container, String folder, String versionID, String iterationID, Map moreDataIn, File[] binaryContent, EPMAuthoringAppType authoringApp, EPMAuthoringAppVersion appVersion) create a new EPMDocument
static WTUser	createUser(Map<String,String> atts)
static WTDocument	createWTDoc(String docNumber, String docName, String container, String folder, String versionID, String iterationID, Map moreData, File[] binaryContent) create a new wtdocument
static WTDocument	createWTDoc(String docNumber, String docName, WTContainer container, String folder, String versionID, String iterationID, Map moreDataIn, File[] binaryContent) create a new wtdocument
static WTPart	createWTPart(String partNumber, String partName, String container, String folder, String versionID, String iterationID) see method with full signature - passes empty map
static WTPart	createWTPart(String partNumber, String partName, String container, String folder, String versionID, String iterationID, boolean makePersistent) see method with full signature - passes empty map
static WTPart	createWTPart(String partNumber, String partName, String container, String folder, String versionID, String iterationID, Map moreData) see method with full signature - passes makePersistent=true
static WTPart	createWTPart(String partNumber, String partName, String container, String folder, String versionID, String iterationID, Map moreDataIn, boolean makePersistent) create a wtpart and make it persistent (if makePersistent flag is true)
static WTPart	createWTPart(String partNumber, String partName, WTContainer container, String folder, String versionID, String iterationID, Map moreDataIn, boolean makePersistent)
static String	getSortSeriesSortId(SeriesSortValue ssv) TODO javadoc
static String	getSortSeriesUniqueId(SeriesSortValue ssv) TODO javadoc
static String	getSortSeriesValue(SeriesSortValue ssv) TODO javadoc
static void	main(String[] a) commandline invocation of import.
static void	renameAndRenumberObj(Persistable obj2rename, String newName, String newNumber, String newCadName) lets you set new number/name[/cadname] on object (wtpart/wtdocument/epmdocument)
static void	renameEPMDocument(EPMDocumentMaster d, String number, String name, String cadName) TODO javadoc
static EPMDocument	renameEPMDocument(EPMDocument d, String number, String name, String cadName) renames an EPMDocument
static void	renameWTPart(WTPartMaster aPart, String number, String name)
static WTPart	renameWTPart(WTPart aPart, String number, String name) renames a WTPart
static void	reviseDummyToVersion(String seriesID, String targetVersion, String containerName) revises a dummy wtpart object to given targetVersion within seriesID BE CAREFUL: method only handles only standard series well.
static void	reviseDummyToVersion(String seriesID, String targetVersion, String containerName, boolean clearCache)
static void	reviseDummyToVersion(String seriesID, String targetVersion, String containerName, boolean clearCache, int maxRounds) TODO javadoc
static Versioned	reviseToVersion(Versioned v, String targetVersion, int maxRounds)
static Versioned	reviseToVersion(Versioned v, String targetVersion, int maxRounds, String comment, String state, boolean clear)
static void	setLifecycleState(Persistable obj, String newLCState) set lifecycle state for given object
static Versioned	setObjectToSpecificVersion(Versioned revObj, String targetVersion) set the given object to a specific revision.
static Versioned	setObjectToSpecificVersion(Versioned revObj, String targetVersion, String targetIteration)
static Versioned	setObjectToSpecificVersion(Versioned revObj, String targetVersion, String targetIteration, String series) set the given object to a specific revision.
static Versioned	setObjectToSpecificVersion(Versioned revObj, String targetVersion, String targetIteration, String series, boolean force) set the given object to a specific revision.

Methods inherited from class Object

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

Field Detail

MAJOR

public static final int MAJOR

See Also:

Constant Field Values

MINOR

public static final int MINOR

See Also:

Constant Field Values

TEMPLATE_NAME

public static final String TEMPLATE_NAME

See Also:

Constant Field Values

DRAWING_TYPE

public static final String DRAWING_TYPE

See Also:

Constant Field Values

DRAWING_SUB_TYPE

public static final String DRAWING_SUB_TYPE

See Also:

Constant Field Values

WTHOME

public static String WTHOME

SERVER

public static final boolean SERVER

getSortValue

public static Method getSortValue

TYPE

public static final String TYPE

See Also:

Constant Field Values

LIFE_CYCLE

public static final String LIFE_CYCLE

See Also:

Constant Field Values

SERIES

public static final String SERIES

See Also:

Constant Field Values

DESCRIPTION

public static final String DESCRIPTION

See Also:

Constant Field Values

DOCTYPE

public static final String DOCTYPE

See Also:

Constant Field Values

DEPARTMENT

public static final String DEPARTMENT

See Also:

Constant Field Values

DEFAULT_UNIT

public static final String DEFAULT_UNIT

See Also:

Constant Field Values

PART_TYPE

public static final String PART_TYPE

See Also:

Constant Field Values

SOURCE

public static final String SOURCE

See Also:

Constant Field Values

STATE

public static final String STATE

See Also:

Constant Field Values

VIEW

public static final String VIEW

See Also:

Constant Field Values

OIR

public static final String OIR

See Also:

Constant Field Values

TEAM

public static final String TEAM

See Also:

Constant Field Values

IS_PHANTOM

public static final String IS_PHANTOM

See Also:

Constant Field Values

WEBJECT

public static final String WEBJECT

See Also:

Constant Field Values

Constructor Detail

SulisLoadHelper

public SulisLoadHelper()

Method Detail

renameAndRenumberObj

public static void renameAndRenumberObj(Persistable obj2rename,
                        String newName,
                        String newNumber,
                        String newCadName)
                                 throws Exception

lets you set new number/name[/cadname] on object (wtpart/wtdocument/epmdocument)

Parameters:

obj2rename -

newName -

newNumber -

newCadName -

Throws:

Exception

main

public static void main(String[] a)
                 throws Exception

commandline invocation of import.

Parameters:

a - commandline parameters

Throws:

Exception

createEPMDoc

public static EPMDocument createEPMDoc(String docNumber,
                       String docName,
                       String cadName,
                       String container,
                       String folder,
                       String versionID,
                       String iterationID,
                       File[] binaryContent)
                                throws Exception

see method with full argument list - this one passes an empty moreData Map to method with next singature

Throws:

Exception

createEPMDoc

public static EPMDocument createEPMDoc(String docNumber,
                       String docName,
                       String cadName,
                       String container,
                       String folder,
                       String versionID,
                       String iterationID,
                       Map moreData,
                       File[] binaryContent)
                                throws Exception

see method with full argument list - this one passes PROE as authoringApplication and 28 L-01 as app version

Throws:

Exception

createEPMDoc

public static EPMDocument createEPMDoc(String docNumber,
                       String docName,
                       String cadName,
                       String container,
                       String folder,
                       String versionID,
                       String iterationID,
                       File[] binaryContent,
                       EPMAuthoringAppType authoringApp,
                       EPMAuthoringAppVersion appVersion)
                                throws Exception

see method with full argument list - this one passes an empty moreData Map

Throws:

Exception

createEPMDoc

public static EPMDocument createEPMDoc(String docNumber,
                       String docName,
                       String cadName,
                       String container,
                       String folder,
                       String versionID,
                       String iterationID,
                       Map moreDataIn,
                       File[] binaryContent,
                       EPMAuthoringAppType authoringApp,
                       EPMAuthoringAppVersion appVersion)
                                throws Exception

create a new EPMDocument

Parameters:

docNumber -

docName -

cadName -

container -

folder -

versionID -

iterationID -

moreData - Map with additional infos for document creation:

key	used for	default
drawingType	String	drawing type, e.g., CADCOMPONENT	CADDRAWING
drawingSubType	String	drawing subtype, e.g., CADCOMPONENT
LifeCycle	String	name of lifecycle template to use	Basic (pass SulisLoadHelper.OIR to retrieve from OIR)
series	String	name of series to use if different from OIR
_type	String	type name (once epmdocs support this ;-)

binaryContent - (first file will be stored as primary content. e.g. proe data file)

Returns:

the new EPMDocument

Throws:

Exception

renameWTPart

public static WTPart renameWTPart(WTPart aPart,
                  String number,
                  String name)
                           throws Exception

renames a WTPart

Parameters:

aPart -

number -

name -

Returns:

the refreshed object

Throws:

Exception

renameWTPart

public static void renameWTPart(WTPartMaster aPart,
                String number,
                String name)
                         throws Exception

Throws:

Exception

renameEPMDocument

public static EPMDocument renameEPMDocument(EPMDocument d,
                            String number,
                            String name,
                            String cadName)
                                     throws Exception

renames an EPMDocument

Parameters:

d -

number -

name -

cadName -

Returns:

the refreshed object

Throws:

Exception

renameEPMDocument

public static void renameEPMDocument(EPMDocumentMaster d,
                     String number,
                     String name,
                     String cadName)
                              throws Exception

TODO javadoc

Parameters:

d -

number -

name -

cadName -

Throws:

Exception

createWTDoc

public static WTDocument createWTDoc(String docNumber,
                     String docName,
                     String container,
                     String folder,
                     String versionID,
                     String iterationID,
                     Map moreData,
                     File[] binaryContent)
                              throws Exception

create a new wtdocument

Parameters:

docNumber -

docName -

container -

folder -

versionID -

iterationID -

binaryContent - (first file is primary content)

Returns:

the new WTDocument

Throws:

Exception

createWTDoc

public static WTDocument createWTDoc(String docNumber,
                     String docName,
                     WTContainer container,
                     String folder,
                     String versionID,
                     String iterationID,
                     Map moreDataIn,
                     File[] binaryContent)
                              throws Exception

create a new wtdocument

Parameters:

docNumber -

docName -

container -

folder -

versionID -

iterationID -

moreData - can hold keys SulisLoadHelper.STATE, SulisLoadHelper.LIFE_CYCLE, SulisLoadHelper.TEAM, SulisLoadHelper.SERIES

binaryContent - (first file is primary content)

Returns:

the new WTDocument

Throws:

Exception

createWTPart

public static WTPart createWTPart(String partNumber,
                  String partName,
                  String container,
                  String folder,
                  String versionID,
                  String iterationID)
                           throws Exception

see method with full signature - passes empty map

Throws:

Exception

createWTPart

public static WTPart createWTPart(String partNumber,
                  String partName,
                  String container,
                  String folder,
                  String versionID,
                  String iterationID,
                  boolean makePersistent)
                           throws Exception

see method with full signature - passes empty map

Throws:

Exception

createWTPart

public static WTPart createWTPart(String partNumber,
                  String partName,
                  String container,
                  String folder,
                  String versionID,
                  String iterationID,
                  Map moreData)
                           throws Exception

see method with full signature - passes makePersistent=true

Throws:

Exception

createWTPart

public static WTPart createWTPart(String partNumber,
                  String partName,
                  String container,
                  String folder,
                  String versionID,
                  String iterationID,
                  Map moreDataIn,
                  boolean makePersistent)
                           throws Exception

create a wtpart and make it persistent (if makePersistent flag is true)

Parameters:

partNumber -

partName -

container -

folder -

versionID -

iterationID -

moreData - Map with additional data for new part, recognized keys are:

• StaticHelper.LIFE_CYCLE name of lifecycle template (pass SulisLoadHelper.OIR to retrieve from OIR)
• StaticHelper.STATE lifecycle state to set (second attempt is LifeCycleState)
• StaticHelper.TYPE name of softtype (either full name or just the last part without reversed internet domain)
• StaticHelper.VIEW name of view
• StaticHelper.DEFAULT_UNIT quantity unit to use
• StaticHelper.PART_TYPE part type to use
• StaticHelper.SOURCE value for source
• StaticHelper.IS_PHANTOM true/false

makePersistent -

Returns:

the new WTPart

Throws:

Exception

createWTPart

public static WTPart createWTPart(String partNumber,
                  String partName,
                  WTContainer container,
                  String folder,
                  String versionID,
                  String iterationID,
                  Map moreDataIn,
                  boolean makePersistent)
                           throws Exception

Throws:

Exception

reviseDummyToVersion

public static void reviseDummyToVersion(String seriesID,
                        String targetVersion,
                        String containerName,
                        boolean clearCache,
                        int maxRounds)
                                 throws Exception

TODO javadoc

Parameters:

seriesID -

targetVersion -

containerName -

clearCache -

Throws:

Exception

reviseToVersion

public static Versioned reviseToVersion(Versioned v,
                        String targetVersion,
                        int maxRounds)
                                 throws Exception

Throws:

Exception

reviseToVersion

public static Versioned reviseToVersion(Versioned v,
                        String targetVersion,
                        int maxRounds,
                        String comment,
                        String state,
                        boolean clear)
                                 throws Exception

Throws:

Exception

setObjectToSpecificVersion

public static Versioned setObjectToSpecificVersion(Versioned revObj,
                                   String targetVersion)
                                            throws Exception

set the given object to a specific revision. IMPORTANT: make sure that targetVersion is LATER than current version!

Parameters:

revObj -

targetVersion -

Returns:

the refreshed object

Throws:

Exception

setObjectToSpecificVersion

public static Versioned setObjectToSpecificVersion(Versioned revObj,
                                   String targetVersion,
                                   String targetIteration)
                                            throws Exception

Parameters:

revObj -

targetVersion -

targetIteration -

Returns:

the refreshed object

Throws:

Exception

setObjectToSpecificVersion

public static Versioned setObjectToSpecificVersion(Versioned revObj,
                                   String targetVersion,
                                   String targetIteration,
                                   String series)
                                            throws Exception

set the given object to a specific revision. IMPORTANT: make sure that targetVersion is LATER than current version and the series contains the version value!

Parameters:

revObj -

targetVersion -

targetIteration -

series -

Returns:

the refreshed object

Throws:

Exception

setObjectToSpecificVersion

public static Versioned setObjectToSpecificVersion(Versioned revObj,
                                   String targetVersion,
                                   String targetIteration,
                                   String series,
                                   boolean force)
                                            throws Exception

set the given object to a specific revision. IMPORTANT: make sure that targetVersion is LATER than current version!

Parameters:

revObj -

targetVersion -

targetIteration -

series -

force - if true does no check about version value and sequence

Returns:

the refreshed object

Throws:

Exception

setLifecycleState

public static void setLifecycleState(Persistable obj,
                     String newLCState)
                              throws Exception

set lifecycle state for given object

Parameters:

obj -

newLCState -

Throws:

Exception

checkForVersion

public static void checkForVersion(String seriesID,
                   String version,
                   boolean createMissingVersion)
                            throws Exception

check if "version" has been initialized (= used) if createMissingVersion is true and version has not been initialized (eg used) yet than the function tries to create the missing version. BE CAREFUL: autocreation is only suggested AND supported with standard series !!!

Parameters:

seriesID -

version -

createMissingVersion -

Throws:

Exception

compareVersions

public static int compareVersions(String seriesID,
                  String versionA,
                  String versionB)
                           throws Exception

compare two versions , returns greater zero versionA < versionB, zero if versions are queal, and a negative int if versionA > versionB

Parameters:

seriesID -

versionA -

versionB -

Returns:

<0/0/>0

Throws:

Exception

compareVersions

public static int compareVersions(String seriesID,
                  String versionA,
                  String versionB,
                  boolean createMissingVersion)
                           throws Exception

compare two versions , returns greater zero versionA < versionB, zero if versions are queal, and a negative int if versionA > versionB if createMissingVersion is true and versionA or versionB have not been initialized (eg used) yet than the functions tries to create the missing version. BE CAREFUL: autocreation is only suggested AND supported with standard series !!!

Parameters:

seriesID -

versionA -

versionB -

createMissingVersion -

Returns:

<0/0/>0

Throws:

Exception

getSortSeriesValue

public static String getSortSeriesValue(SeriesSortValue ssv)

TODO javadoc

Parameters:

ssv -

Returns:

getSortSeriesUniqueId

public static String getSortSeriesUniqueId(SeriesSortValue ssv)

TODO javadoc

Parameters:

ssv -

Returns:

getSortSeriesSortId

public static String getSortSeriesSortId(SeriesSortValue ssv)

TODO javadoc

Parameters:

ssv -

Returns:

reviseDummyToVersion

public static void reviseDummyToVersion(String seriesID,
                        String targetVersion,
                        String containerName)
                                 throws Exception

revises a dummy wtpart object to given targetVersion within seriesID BE CAREFUL: method only handles only standard series well. more complex series setups are NOT SUPPORTED!!

Parameters:

seriesID -

targetVersion -

containerName -

Throws:

Exception

reviseDummyToVersion

public static void reviseDummyToVersion(String seriesID,
                        String targetVersion,
                        String containerName,
                        boolean clearCache)
                                 throws Exception

Throws:

Exception

createUser

public static WTUser createUser(Map<String,String> atts)
                         throws Exception

Throws:

Exception