Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)

125454 amorarasu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
      125307 gjames: ACE-5091: Changed the javadoc formatting for TransactionService


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/BRANCHES/DEV/5.2.N/root@125765 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Raluca Munteanu
2016-04-26 12:14:15 +00:00
parent 6c102b315e
commit e574e67bac

View File

@@ -26,10 +26,10 @@ import org.alfresco.service.NotAuditable;
/** /**
* Contract for retrieving access to a user transaction. * Contract for retrieving access to a user transaction.
* <p> * <p>
* Note that the implementation of the {@link javax.transaction.UserTransaction} * Note that the implementation of the <code>javax.transaction.UserTransaction</code>
* is not able to provide the full set of status codes available on the * is not able to provide the full set of status codes available on the
* {@link javax.transaction.Status} class. * <code>javax.transaction.Status</code> class.
* *
* @author David Caruana * @author David Caruana
*/ */
public interface TransactionService public interface TransactionService
@@ -37,35 +37,35 @@ public interface TransactionService
/** /**
* Determine if the repository has been put into read only mode. * Determine if the repository has been put into read only mode.
* This is independent of the current user. * This is independent of the current user.
* *
* @return <tt>true</tt> if the repository is allowed to perform * @return <tt>true</tt> if the repository is allowed to perform
* write operations * write operations
*/ */
public boolean getAllowWrite(); public boolean getAllowWrite();
/** /**
* Determine if ALL user transactions will be read-only. The 'System' * Determine if ALL user transactions will be read-only. The 'System'
* user is always allowed to write. * user is always allowed to write.
* *
* @return Returns true if all transactions are read-only AND the current * @return Returns true if all transactions are read-only AND the current
* user is not the 'System' user. * user is not the 'System' user.
*/ */
@NotAuditable @NotAuditable
public boolean isReadOnly(); public boolean isReadOnly();
/** /**
* Gets a user transaction that supports transaction propagation. * Gets a user transaction that supports transaction propagation.
* This is like the EJB <b>REQUIRED</b> transaction attribute. * This is like the EJB <b>REQUIRED</b> transaction attribute.
* *
* @return the user transaction * @return the user transaction
*/ */
@NotAuditable @NotAuditable
UserTransaction getUserTransaction(); UserTransaction getUserTransaction();
/** /**
* Gets a user transaction that supports transaction propagation. * Gets a user transaction that supports transaction propagation.
* This is like the EJB <b>REQUIRED</b> transaction attribute. * This is like the EJB <b>REQUIRED</b> transaction attribute.
* *
* @param readOnly Set true for a READONLY transaction instance, false otherwise. * @param readOnly Set true for a READONLY transaction instance, false otherwise.
* Note that it is not <i>always</i> possible to force a write transaction if the * Note that it is not <i>always</i> possible to force a write transaction if the
* system is in read-only mode. * system is in read-only mode.
@@ -73,11 +73,11 @@ public interface TransactionService
*/ */
@NotAuditable @NotAuditable
UserTransaction getUserTransaction(boolean readOnly); UserTransaction getUserTransaction(boolean readOnly);
/** /**
* Gets a user transaction that supports transaction propagation. * Gets a user transaction that supports transaction propagation.
* This is like the EJB <b>REQUIRED</b> transaction attribute. * This is like the EJB <b>REQUIRED</b> transaction attribute.
* *
* @param readOnly Set true for a READONLY transaction instance, false otherwise. * @param readOnly Set true for a READONLY transaction instance, false otherwise.
* @param ignoreSystemReadOnly <tt>true</tt> to force the read-only flag to be respected regardless * @param ignoreSystemReadOnly <tt>true</tt> to force the read-only flag to be respected regardless
* of the system read-only mode. * of the system read-only mode.
@@ -85,26 +85,26 @@ public interface TransactionService
*/ */
@NotAuditable @NotAuditable
UserTransaction getUserTransaction(boolean readOnly, boolean ignoreSystemReadOnly); UserTransaction getUserTransaction(boolean readOnly, boolean ignoreSystemReadOnly);
/** /**
* Gets a user transaction that ensures a new transaction is created. * Gets a user transaction that ensures a new transaction is created.
* Any enclosing transaction is not propagated. * Any enclosing transaction is not propagated.
* This is like the EJB <b>REQUIRES_NEW</b> transaction attribute - * This is like the EJB <b>REQUIRES_NEW</b> transaction attribute -
* when the transaction is started, the current transaction will be * when the transaction is started, the current transaction will be
* suspended and a new one started. * suspended and a new one started.
* *
* @return Returns a non-propagating user transaction * @return Returns a non-propagating user transaction
*/ */
@NotAuditable @NotAuditable
UserTransaction getNonPropagatingUserTransaction(); UserTransaction getNonPropagatingUserTransaction();
/** /**
* Gets a user transaction that ensures a new transaction is created. * Gets a user transaction that ensures a new transaction is created.
* Any enclosing transaction is not propagated. * Any enclosing transaction is not propagated.
* This is like the EJB <b>REQUIRES_NEW</b> transaction attribute - * This is like the EJB <b>REQUIRES_NEW</b> transaction attribute -
* when the transaction is started, the current transaction will be * when the transaction is started, the current transaction will be
* suspended and a new one started. * suspended and a new one started.
* *
* @param readOnly Set true for a READONLY transaction instance, false otherwise. * @param readOnly Set true for a READONLY transaction instance, false otherwise.
* Note that it is not <i>always</i> possible to force a write transaction if the * Note that it is not <i>always</i> possible to force a write transaction if the
* system is in read-only mode. * system is in read-only mode.
@@ -112,14 +112,14 @@ public interface TransactionService
*/ */
@NotAuditable @NotAuditable
UserTransaction getNonPropagatingUserTransaction(boolean readOnly); UserTransaction getNonPropagatingUserTransaction(boolean readOnly);
/** /**
* Gets a user transaction that ensures a new transaction is created. * Gets a user transaction that ensures a new transaction is created.
* Any enclosing transaction is not propagated. * Any enclosing transaction is not propagated.
* This is like the EJB <b>REQUIRES_NEW</b> transaction attribute - * This is like the EJB <b>REQUIRES_NEW</b> transaction attribute -
* when the transaction is started, the current transaction will be * when the transaction is started, the current transaction will be
* suspended and a new one started. * suspended and a new one started.
* *
* @param readOnly Set true for a READONLY transaction instance, false otherwise. * @param readOnly Set true for a READONLY transaction instance, false otherwise.
* @param ignoreSystemReadOnly <tt>true</tt> to force the read-only flag to be respected regardless * @param ignoreSystemReadOnly <tt>true</tt> to force the read-only flag to be respected regardless
* of the system read-only mode. * of the system read-only mode.
@@ -127,10 +127,10 @@ public interface TransactionService
*/ */
@NotAuditable @NotAuditable
UserTransaction getNonPropagatingUserTransaction(boolean readOnly, boolean ignoreSystemReadOnly); UserTransaction getNonPropagatingUserTransaction(boolean readOnly, boolean ignoreSystemReadOnly);
/** /**
* Get the standard instance of the helper object that supports transaction retrying. * Get the standard instance of the helper object that supports transaction retrying.
* *
* @return * @return
* Returns a helper object that executes units of work transactionally. The helper * Returns a helper object that executes units of work transactionally. The helper
* can be reused or altered as required. * can be reused or altered as required.