Package com.attivio.sdk.schema
Interface SchemaApi
-
- All Superinterfaces:
SchemaUtil
- All Known Implementing Classes:
MockSchemaApi
public interface SchemaApi extends SchemaUtil
API for working with available schemas.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default Schema
addSchema(Schema schema)
Add/updateschema
Schema
getSchema(java.lang.String schemaName)
Fetch a schema according toschemaName
.java.util.List<java.lang.String>
getSchemaNames()
Get the names of all available schemas.default void
removeSchema(java.lang.String schemaName)
Remove a schema from the system.-
Methods inherited from interface com.attivio.sdk.server.util.SchemaUtil
getDefaultSchema
-
-
-
-
Method Detail
-
getSchemaNames
java.util.List<java.lang.String> getSchemaNames() throws AttivioException
Get the names of all available schemas.- Throws:
AttivioException
-
getSchema
Schema getSchema(java.lang.String schemaName)
Fetch a schema according toschemaName
.If
schemaName
isnull
, the default schema will be returned, if available.Returns
null
if schema does not exist.- Specified by:
getSchema
in interfaceSchemaUtil
- Parameters:
schemaName
- the schema name- Returns:
- the schema
-
addSchema
default Schema addSchema(Schema schema) throws AttivioException
Add/updateschema
WARNING: System restart will be required for all components to take notice of the new/modified schema.
- Throws:
AttivioException
-
removeSchema
default void removeSchema(java.lang.String schemaName) throws AttivioException
Remove a schema from the system.WARNING: System restart will be required for all components to take notice of the removed schema.
- Throws:
AttivioException
-
-