public interface SessionSettings extends TransientObject
apply()
is callsed.
Modifier and Type | Method and Description |
---|---|
boolean |
administrationBypass()
Returns a flag controlling the Teamcenter administrator's bypass option.
|
boolean |
administrationLogging()
Returns a flag controlling Teamcenter administration logging.
|
boolean |
applicationLogging()
Returns a flag controlling Teamcenter application logging
License requirements: None. |
void |
apply()
Applies any changes to the settings
License requirements: None. |
void |
dumpValidationInfo(String logFileName)
Dump the validation info .This API can be used to expose the current state from the
UGMGR session, typically the information about the session,assembly,components,their states
etc.
|
String[] |
getGroups()
Gets the names of the Teamcenter groups to which the
user belongs.
|
String[] |
getLocalVolumes()
Gets the names of the Teamcenter local volumes which the user may use,
given the current group returned by
group() . |
String[] |
getLocationCodes()
Gets the names of the Teamcenter location codes which the user may use,
given the current group returned by
group() . |
String[] |
getProjects()
Gets the names of the Teamcenter projects to which the user belongs also
the first entry of the returned projects list is always empty.
|
String[] |
getRoles()
Gets the names of the Teamcenter roles in which the
user may act, given the current group returned by
group() . |
String[] |
getVolumes()
Gets the names of the Teamcenter volumes which the
user may use, given the current group returned by
group() . |
String |
group()
Returns the Teamcenter group in which the user acts.
|
boolean |
isAdministrator()
Returns a flag indicating if the user has Teamcenter administator privileges.
|
boolean |
journaling()
Returns a flag controlling Teamcenter journaling
License requirements: None. |
String |
localVolume()
Returns the Teamcenter local volume.
|
String |
locationCode()
Returns the Teamcenter location code.
|
String |
project()
Returns the Teamcenter project in which the user acts.
|
String |
role()
Returns the Teamcenter role in which the user acts.
|
boolean |
securityLogging()
Returns a flag controlling Teamcenter security logging.
|
void |
setAdministrationBypass(boolean adminBypassOn)
License requirements: None. |
void |
setAdministrationLogging(boolean adminLoggingOn)
License requirements: None. |
void |
setApplicationLogging(boolean appLoggingOn)
License requirements: None. |
void |
setGroup(String group)
License requirements: None. |
void |
setJournaling(boolean journalingOn)
License requirements: None. |
void |
setLocalVolume(String localvolume)
License requirements: None. |
void |
setLocationCode(String locationCode)
License requirements: None. |
void |
setProject(String project)
License requirements: None. |
void |
setRole(String role)
License requirements: None. |
void |
setSecurityLogging(boolean securityLoggingOn)
License requirements: None. |
void |
setVolume(String volume)
License requirements: None. |
String |
volume()
Returns the Teamcenter role in which the user acts.
|
_value, dispose, printTestData, printTestData
boolean isAdministrator() throws NXException, RemoteException
NXException
RemoteException
String[] getGroups() throws NXException, RemoteException
NXException
RemoteException
String[] getRoles() throws NXException, RemoteException
group()
.
NXException
RemoteException
String[] getVolumes() throws NXException, RemoteException
group()
.
NXException
RemoteException
String[] getLocalVolumes() throws NXException, RemoteException
group()
.
NXException
RemoteException
String[] getLocationCodes() throws NXException, RemoteException
group()
.
NXException
RemoteException
String[] getProjects() throws NXException, RemoteException
NXException
RemoteException
void setGroup(String group) throws NXException, RemoteException
group
- NXException
RemoteException
String group() throws NXException, RemoteException
getGroups()
NXException
RemoteException
void setRole(String role) throws NXException, RemoteException
role
- NXException
RemoteException
String role() throws NXException, RemoteException
getRoles()
NXException
RemoteException
void setVolume(String volume) throws NXException, RemoteException
volume
- NXException
RemoteException
String volume() throws NXException, RemoteException
getVolumes()
NXException
RemoteException
void setLocalVolume(String localvolume) throws NXException, RemoteException
localvolume
- NXException
RemoteException
String localVolume() throws NXException, RemoteException
getLocalVolumes()
NXException
RemoteException
void setLocationCode(String locationCode) throws NXException, RemoteException
locationCode
- NXException
RemoteException
String locationCode() throws NXException, RemoteException
getLocationCodes()
NXException
RemoteException
void setProject(String project) throws NXException, RemoteException
project
- NXException
RemoteException
String project() throws NXException, RemoteException
getProjects()
NXException
RemoteException
void setApplicationLogging(boolean appLoggingOn) throws NXException, RemoteException
appLoggingOn
- NXException
RemoteException
boolean applicationLogging() throws NXException, RemoteException
NXException
RemoteException
void setJournaling(boolean journalingOn) throws NXException, RemoteException
journalingOn
- NXException
RemoteException
boolean journaling() throws NXException, RemoteException
NXException
RemoteException
void setAdministrationLogging(boolean adminLoggingOn) throws NXException, RemoteException
adminLoggingOn
- NXException
RemoteException
boolean administrationLogging() throws NXException, RemoteException
NXException
RemoteException
void setSecurityLogging(boolean securityLoggingOn) throws NXException, RemoteException
securityLoggingOn
- NXException
RemoteException
boolean securityLogging() throws NXException, RemoteException
NXException
RemoteException
void setAdministrationBypass(boolean adminBypassOn) throws NXException, RemoteException
adminBypassOn
- NXException
RemoteException
boolean administrationBypass() throws NXException, RemoteException
NXException
RemoteException
void apply() throws NXException, RemoteException
NXException
RemoteException
void dumpValidationInfo(String logFileName) throws NXException, RemoteException
logFileName
- log file nameNXException
RemoteException
Copyright 2017 Siemens Product Lifecycle Management Software Inc. All Rights Reserved.