public interface OptionContainer extends KomodoObject
options
.EMPTY_ARRAY
Modifier and Type | Method and Description |
---|---|
StatementOption[] |
getCustomOptions(Repository.UnitOfWork transaction) |
default Map<String,String> |
getStandardOptions() |
String[] |
getStatementOptionNames(Repository.UnitOfWork transaction)
This result includes both the standard statement options and any custom options that have been set.
|
StatementOption[] |
getStatementOptions(Repository.UnitOfWork transaction) |
boolean |
isCustomOption(Repository.UnitOfWork transaction,
String name) |
boolean |
isStandardOption(String name)
A standard option is a statement option that is built-in/well known.
|
void |
removeStatementOption(Repository.UnitOfWork transaction,
String optionToRemove) |
StatementOption |
setStatementOption(Repository.UnitOfWork transaction,
String optionName,
String optionValue) |
accept, addChild, addDescriptor, getChild, getChild, getChildren, getChildrenOfType, getChildTypes, getDescriptor, getDescriptors, getIndex, getObjectFactory, getPrimaryType, getProperty, getPropertyDescriptor, getPropertyDescriptors, getPropertyFactory, getPropertyNames, getRawChildren, getRawDescriptors, getRawParent, getRawProperty, getRawPropertyDescriptors, getRawPropertyNames, getTypeId, getTypeIdentifier, hasChild, hasChild, hasChildren, hasDescriptor, hasProperties, hasProperty, hasRawChild, hasRawChild, hasRawChildren, hasRawProperty, isChildRestricted, print, remove, removeChild, removeDescriptor, rename, setPrimaryType, setProperty
getAbsolutePath, getName, getParent, getRepository
StatementOption[] getCustomOptions(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursdefault Map<String,String> getStandardOptions()
null
but can be empty)String[] getStatementOptionNames(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
))null
but can be empty)KException
- if an error occursStatementOption[] getStatementOptions(Repository.UnitOfWork transaction) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)null
but can be empty)KException
- if an error occursboolean isCustomOption(Repository.UnitOfWork transaction, String name) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)name
- the name of the option being checked (cannot be empty)true
if the custom option existsKException
- if an error occursboolean isStandardOption(String name)
name
- the name of the option being checked (cannot be empty)true
if a standard optionvoid removeStatementOption(Repository.UnitOfWork transaction, String optionToRemove) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)optionToRemove
- the name of the statement option being removed (cannot be empty)KException
- if an error occursStatementOption setStatementOption(Repository.UnitOfWork transaction, String optionName, String optionValue) throws KException
transaction
- the transaction (cannot be null
or have a state that is not Repository.UnitOfWork.State.NOT_STARTED
)optionName
- the name of the statement option being added (cannot be empty)optionValue
- the statement option value (can be empty if removing the option)null
if removed)KException
- if an error occursCopyright © 2013–2019. All rights reserved.