com.sage.orion.sdata.servlet.swtservice
Class PagesResourceKind

java.lang.Object
  extended by com.sage.orion.sdata.servlet.JDBCResourceKind
      extended by com.sage.orion.sdata.servlet.swtservice.PagesResourceKind
All Implemented Interfaces:
ResourceKind

public class PagesResourceKind
extends JDBCResourceKind

This class handles the Pages Resource Kind


Nested Class Summary
 
Nested classes/interfaces inherited from class com.sage.orion.sdata.servlet.JDBCResourceKind
JDBCResourceKind.HTTPMethodsAuthorizator, JDBCResourceKind.ResourceAuthorizator, JDBCResourceKind.ResourceDataAuthorizator
 
Field Summary
 
Fields inherited from class com.sage.orion.sdata.servlet.JDBCResourceKind
ADD, ALTER_TABLE, AND, CLOSE_BRACE, COMMA, CONSTRAINT, DEFAULT, DEFAULT_LANGUAGE_CODE, DELETE_FROM, DROP, DROP_TABLE, FROM, NOT_NULL, OPEN_BRACE, PRIMARY_KEY, SELECT, UICONTENT_SQL_SELECT_STMT, VARCHAR_50, WHERE
 
Constructor Summary
PagesResourceKind(ApplicationContext applicationContext, ConnectionPool connectionPool, java.lang.String authToken)
          Constructor
 
Method Summary
protected  boolean canGetOnData(SDataRequest request, java.sql.Connection connection)
          Indicates whether the user has the privilege to GET the data specified in the request.
protected static void doCreateTable(ApplicationContext context, java.sql.Connection connection, JDBCDatabaseType databaseType)
           
protected  java.util.List<FieldDefinition> getAllFields()
          returns a list of FieldDefinitions in the ResourceKind
protected  java.lang.String getCalculateFieldValue(java.lang.String value, SDataRequest request, java.sql.ResultSet resultSet, int fieldIndex)
          Get the value of the calculated field, if it is a regular (non-calculated) field then the original value will be returned unchanged
 java.lang.String getName()
           
static java.lang.String getPagesTableName()
          Static method returns the data base table name for the PagesResourceKind
protected  java.lang.String[] getPrimaryKey()
          Get the primary key of the underlying JDBC table for which one JDBCResourceKindImpl is created
protected static java.util.List<FieldDefinition> getTableFields()
           
protected  java.lang.String getTableName()
          Get the JDBC table name for which ResourceKindImpl is created
protected  java.lang.String getUserIDForFilter()
          Gets the user id used in the filter for retrieving the data related to the current signed on user.
 boolean isUserSpecificResource()
          Indicates whether the resource is user specific or not.
protected  boolean supportDelete()
          Indicates whether the ResourceKind in general supports DELETE or not.
protected  boolean supportGet()
          Indicates whether the ResourceKind in general supports GET or not.
protected  boolean supportPost()
          Indicates whether the ResourceKind in general supports POST or not.
protected  boolean supportPut()
          Indicates whether the ResourceKind in general supports PUT or not.
 
Methods inherited from class com.sage.orion.sdata.servlet.JDBCResourceKind
addCompanyIDField, addRecordsForAllCompanies, buildUserFilter, canDelete, canDeleteOnData, canGet, canPost, canPostOnData, canPut, canPutOnData, createPreparedEntryGetStatement, doDelete, doGet, doPost, doPut, doSchema, doTemplate, fillResultSetResourceElement, findUIContentTextValueInDB, focusOnResultSet, freeConnection, getApplicationContext, getAuthToken, getCaseInsensitiveColumns, getColumnNamesFromList, getCompanyIDField, getCompanyIDForFilter, getConnection, getCurrentRequest, getCurrentUser, getCustomizedQuery, getDatabaseType, getDefaultFeedCount, getFieldData, getFieldSchemaIdentity, getFieldSchemaName, getFieldSchemaType, getIncludeColumns, getInstance, getKeyValueForKeyName, getMaxFeedCount, getOrderByClause, getOrderByClauseForKeyField, getPreparedStatement, getQueryStringForParam, getResourceKindFieldsCount, getResultRecordAndCreateResponse, getSchema, getTemplate, getTransText, getUserIDField, handleRequest, maintainTable, moveRecordPointerToKeyInURL, requiresCompanyIdInjection, requiresSignon, requiresUserIdInjection, shutdown, splitKeyIntoSegments, splitResourceSelectorKeyIntoSegments
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PagesResourceKind

public PagesResourceKind(ApplicationContext applicationContext,
                         ConnectionPool connectionPool,
                         java.lang.String authToken)
Constructor

Parameters:
applicationContext - SData application context
connectionPool - connectionPool of the underline DB
authToken - the authentication token
Method Detail

doCreateTable

protected static void doCreateTable(ApplicationContext context,
                                    java.sql.Connection connection,
                                    JDBCDatabaseType databaseType)

getPrimaryKey

protected java.lang.String[] getPrimaryKey()
Description copied from class: JDBCResourceKind
Get the primary key of the underlying JDBC table for which one JDBCResourceKindImpl is created

Specified by:
getPrimaryKey in class JDBCResourceKind
Returns:
the primary key

getTableName

protected java.lang.String getTableName()
Description copied from class: JDBCResourceKind
Get the JDBC table name for which ResourceKindImpl is created

Specified by:
getTableName in class JDBCResourceKind
Returns:
the JDBC table name

getName

public java.lang.String getName()

getTableFields

protected static java.util.List<FieldDefinition> getTableFields()

getAllFields

protected java.util.List<FieldDefinition> getAllFields()
returns a list of FieldDefinitions in the ResourceKind

Specified by:
getAllFields in class JDBCResourceKind
Returns:
FieldDefinition list

getCalculateFieldValue

protected java.lang.String getCalculateFieldValue(java.lang.String value,
                                                  SDataRequest request,
                                                  java.sql.ResultSet resultSet,
                                                  int fieldIndex)
Get the value of the calculated field, if it is a regular (non-calculated) field then the original value will be returned unchanged

Specified by:
getCalculateFieldValue in class JDBCResourceKind
Parameters:
value - value of the field
request - the input SDataRequest
resultSet - resultSet returned by query
fieldIndex - fieldIndex - 0-based
Returns:
the value of the field

isUserSpecificResource

public boolean isUserSpecificResource()
Indicates whether the resource is user specific or not. If the resource is user specific, it generally requires user sign on.

Specified by:
isUserSpecificResource in class JDBCResourceKind
Returns:
True if the resource is user specific, false otherwise.

supportDelete

protected boolean supportDelete()
Indicates whether the ResourceKind in general supports DELETE or not.

Specified by:
supportDelete in class JDBCResourceKind
Returns:
True if the ResourceKind supports DELETE, false otherwise.

supportGet

protected boolean supportGet()
Indicates whether the ResourceKind in general supports GET or not.

Specified by:
supportGet in class JDBCResourceKind
Returns:
True if the ResourceKind supports GET, false otherwise.

supportPost

protected boolean supportPost()
Indicates whether the ResourceKind in general supports POST or not.

Specified by:
supportPost in class JDBCResourceKind
Returns:
True if the ResourceKind supports POST, false otherwise.

supportPut

protected boolean supportPut()
Indicates whether the ResourceKind in general supports PUT or not.

Specified by:
supportPut in class JDBCResourceKind
Returns:
True if the ResourceKind supports PUT, false otherwise.

canGetOnData

protected boolean canGetOnData(SDataRequest request,
                               java.sql.Connection connection)
                        throws java.sql.SQLException
Indicates whether the user has the privilege to GET the data specified in the request.

Overrides:
canGetOnData in class JDBCResourceKind
Parameters:
request - The GET request.
connection - The database connection.
Returns:
True is the user has the privilege to GET the data specified in the request.
Throws:
java.sql.SQLException - SQLException

getUserIDForFilter

protected java.lang.String getUserIDForFilter()
Gets the user id used in the filter for retrieving the data related to the current signed on user.

Overrides:
getUserIDForFilter in class JDBCResourceKind
Returns:
user id string

getPagesTableName

public static java.lang.String getPagesTableName()
Static method returns the data base table name for the PagesResourceKind

Returns:
table name


Copyright © 2011 Sage Software, Inc. All rights reserved.