inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-08-07 17:49:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding Public API annotation per ALF-19074

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@55507 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Greg Melahn
2013-09-19 00:12:36 +00:00
parent a83dd53137
commit 432a7a703e
85 changed files with 2830 additions and 2623 deletions
Download Patch File Download Diff File Expand all files Collapse all files

150
source/java/org/alfresco/repo/policy/Behaviour.java
View File

@@ -1,74 +1,76 @@
/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.policy;
/**
* A Behaviour represents an encapsulated piece of logic (system or business)
* that may be bound to a Policy. The logic may be expressed in any
* language (java, script etc).
*
* Once bound to a Policy, the behaviour must be able to provide the interface
* declared by that policy.
*
* @author David Caruana
*/
public interface Behaviour
{
/**
* When should behaviour be notified?
*/
public enum NotificationFrequency
{
EVERY_EVENT,
FIRST_EVENT,
TRANSACTION_COMMIT
}
/**
* Gets the requested policy interface onto the behaviour
*
* @param policy the policy interface class
* @return the policy interface
*/
public <T> T getInterface(Class<T> policy);
/**
* Disable the behaviour (for this thread only)
*/
public void disable();
/**
* Enable the behaviour (for this thread only)
*/
public void enable();
/**
* @return is the behaviour enabled (for this thread only)
*/
public boolean isEnabled();
/**
* @return the notification
*/
public NotificationFrequency getNotificationFrequency();
}
/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* Alfresco is free software: you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Alfresco is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
*/
package org.alfresco.repo.policy;
import org.alfresco.api.AlfrescoPublicApi;
/**
* A Behaviour represents an encapsulated piece of logic (system or business)
* that may be bound to a Policy. The logic may be expressed in any
* language (java, script etc).
*
* Once bound to a Policy, the behaviour must be able to provide the interface
* declared by that policy.
*
* @author David Caruana
*/
@AlfrescoPublicApi
public interface Behaviour
{
/**
* When should behaviour be notified?
*/
public enum NotificationFrequency
{
EVERY_EVENT,
FIRST_EVENT,
TRANSACTION_COMMIT
}
/**
* Gets the requested policy interface onto the behaviour
*
* @param policy the policy interface class
* @return the policy interface
*/
public <T> T getInterface(Class<T> policy);
/**
* Disable the behaviour (for this thread only)
*/
public void disable();
/**
* Enable the behaviour (for this thread only)
*/
public void enable();
/**
* @return is the behaviour enabled (for this thread only)
*/
public boolean isEnabled();
/**
* @return the notification
*/
public NotificationFrequency getNotificationFrequency();
}